xapian-core
1.4.26
|
Class for iterating over a list of terms. More...
#include <postingiterator.h>
Public Member Functions | |
PostingIterator (const PostingIterator &o) | |
Copy constructor. | |
PostingIterator & | operator= (const PostingIterator &o) |
Assignment. | |
PostingIterator () | |
Default constructor. | |
~PostingIterator () | |
Destructor. | |
Xapian::docid | operator* () const |
Return the document id at the current position. | |
Xapian::termcount | get_wdf () const |
Return the wdf for the document at the current position. | |
Xapian::termcount | get_doclength () const |
Return the length of the document at the current position. | |
Xapian::termcount | get_unique_terms () const |
Return the number of unique terms in the current document. | |
PositionIterator | positionlist_begin () const |
Return a PositionIterator for the current document. | |
PositionIterator | positionlist_end () const |
Return an end PositionIterator for the current document. | |
PostingIterator & | operator++ () |
Advance the iterator to the next position. | |
DerefWrapper_< Xapian::docid > | operator++ (int) |
Advance the iterator to the next position (postfix version). | |
void | skip_to (Xapian::docid did) |
Advance the iterator to document did. | |
std::string | get_description () const |
Return a string describing this object. | |
Class for iterating over a list of terms.
|
inline |
Default constructor.
Creates an uninitialised iterator, which can't be used before being assigned to, but is sometimes syntactically convenient.
void Xapian::PostingIterator::skip_to | ( | Xapian::docid | did | ) |
Advance the iterator to document did.
did | The document id to advance to. If this document id isn't in the stream being iterated, then the iterator is moved to the next document id after it which is. |