Xapian::PositionIterator - Iterate over sets of positions.
This iterator represents a stream of positions for a term. It overloads ++
for advancing the iterator, or you can explicitly call the inc
method. This class also overloads eq
, ne
, ==
, and !=
.
Search::Xapian overloads <""> (stringification) on this class to call the get_description
method. Call get_description
explicitly instead.
Search::Xapian overloads <0+> (convert to an integer) on this class to call the get_termpos
method. Call get_termpos
explicitly instead.
Constructor. Defaults to an uninitialized iterator.
Advance the iterator by one. (Called implicitly by ++
overloading).
Advance the iterator to term position termpos, or the first term position after termpos if termpos isn't in the list of term positions being iterated.
Compare for equality with another Xapian::PositionIterator object. Also overloaded to the eq
and ==
operators.
Compare for inequality with another Xapian::PositionIterator object. Also overloaded to the ne
and !=
operators.
Return the term position the iterator is currently on.
Return a description of this object.