strus  0.17
Public Member Functions | List of all members
strus::SummarizationVariable Class Reference

Structure describing a variable referencing a named match of a subexpression. Variables are attached to features used for summarization. More...

#include <summarizationVariable.hpp>

Public Member Functions

 SummarizationVariable (const std::string &name_, PostingIteratorInterface *itr_)
 Constructor. More...
 
 SummarizationVariable (const SummarizationVariable &o)
 Copy constructor. More...
 
const std::string & name () const
 Name of the variable. More...
 
Index position () const
 Feature occurrence attached to this variable at the current position of the summarizer feature posting iterator this variable is attached to. More...
 
const PostingIteratorInterfaceitr () const
 Posting iterator of the variable. More...
 

Detailed Description

Structure describing a variable referencing a named match of a subexpression. Variables are attached to features used for summarization.

Constructor & Destructor Documentation

strus::SummarizationVariable::SummarizationVariable ( const std::string &  name_,
PostingIteratorInterface itr_ 
)
inline

Constructor.

Parameters
[in]name_name of the variable
[in]itr_pointer to postinglist representing the variable (owned by caller)
strus::SummarizationVariable::SummarizationVariable ( const SummarizationVariable o)
inline

Copy constructor.

Parameters
[in]ovariable to copy

Member Function Documentation

const PostingIteratorInterface* strus::SummarizationVariable::itr ( ) const
inline

Posting iterator of the variable.

Returns
the posting iterator pointer of this variable
const std::string& strus::SummarizationVariable::name ( ) const
inline

Name of the variable.

Index strus::SummarizationVariable::position ( ) const
inline

Feature occurrence attached to this variable at the current position of the summarizer feature posting iterator this variable is attached to.

Returns
the current position

The documentation for this class was generated from the following file: