Public Member Functions | List of all members
Xapian::PositionIterator Class Reference

Class for iterating over term positions. More...

Public Member Functions

 PositionIterator (const PositionIterator &o)
 Copy constructor.
 
PositionIteratoroperator= (const PositionIterator &o)
 Assignment.
 
 PositionIterator ()
 Default constructor. More...
 
 ~PositionIterator ()
 Destructor.
 
Xapian::termpos operator* () const
 Return the term position at the current iterator position.
 
PositionIteratoroperator++ ()
 Advance the iterator to the next position.
 
DerefWrapper_< Xapian::termposoperator++ (int)
 Advance the iterator to the next position (postfix version).
 
void skip_to (Xapian::termpos termpos)
 Advance the iterator to term position termpos. More...
 
std::string get_description () const
 Return a string describing this object.
 

Detailed Description

Class for iterating over term positions.

Constructor & Destructor Documentation

◆ PositionIterator()

Xapian::PositionIterator::PositionIterator ( )
inline

Default constructor.

Creates an uninitialised iterator, which can't be used before being assigned to, but is sometimes syntactically convenient.

Member Function Documentation

◆ skip_to()

void Xapian::PositionIterator::skip_to ( Xapian::termpos  termpos)

Advance the iterator to term position termpos.

Parameters
termposThe position to advance to. If this position isn't in the stream being iterated, then the iterator is moved to the next term position after it which is.

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

Documentation for Xapian (version 1.4.9).
Generated on Sat Nov 3 2018 by Doxygen 1.8.13.