Structure that represents a set of feature occurrencies (postings) as iterator.
More...
#include <postingIteratorInterface.hpp>
Structure that represents a set of feature occurrencies (postings) as iterator.
| virtual strus::PostingIteratorInterface::~PostingIteratorInterface |
( |
| ) |
|
|
inlinevirtual |
| virtual Index strus::PostingIteratorInterface::docno |
( |
| ) |
const |
|
pure virtual |
Get the current document number.
- Returns
- the document number
| virtual Index strus::PostingIteratorInterface::documentFrequency |
( |
| ) |
const |
|
pure virtual |
Get the number of documents where the feature occurrs.
- Returns
- the document frequency (aka 'df')
| virtual const char* strus::PostingIteratorInterface::featureid |
( |
| ) |
const |
|
pure virtual |
Unique id in the system for a feature expression used for debugging and tracing.
- Returns
- the id string
| virtual unsigned int strus::PostingIteratorInterface::frequency |
( |
| ) |
|
|
pure virtual |
Get the frequency of the feature in the current document.
- Returns
- the feature frequency (aka 'ff' of 'tf')
| virtual Index strus::PostingIteratorInterface::length |
( |
| ) |
const |
|
pure virtual |
Get the ordinal position length of the current match.
- Returns
- the ordinal position length
| virtual Index strus::PostingIteratorInterface::posno |
( |
| ) |
const |
|
pure virtual |
Get the current position number.
- Returns
- the position number
| virtual Index strus::PostingIteratorInterface::skipDoc |
( |
const Index & |
docno | ) |
|
|
pure virtual |
Return the next document match with a document number higher than or equal to a given document number.
- Parameters
-
| [in] | docno | the minimum document number to fetch |
| virtual Index strus::PostingIteratorInterface::skipDocCandidate |
( |
const Index & |
docno | ) |
|
|
pure virtual |
Return a candidate with a document number higher than or equal to a given document number without guarantee, that the document has matching positions.
- Note
- Used for optimizing complex join operations that would first like to make a join on the document sets, before looking at the positions
- Parameters
-
| [in] | docno | the minimum document number to fetch |
| virtual Index strus::PostingIteratorInterface::skipPos |
( |
const Index & |
firstpos | ) |
|
|
pure virtual |
Return the next matching position higher than or equal to firstpos in the current document. The current document is the one returned with the last 'skipDoc( const Index&)' call.
- Parameters
-
| [in] | firstpos | the minimum position to fetch |
The documentation for this class was generated from the following file:
