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

Iterator over a Xapian::MSet. More...

Public Member Functions

 MSetIterator ()
 Create an unpositioned MSetIterator. More...
 
Xapian::docid operator* () const
 Get the numeric document id for the current position. More...
 
MSetIteratoroperator++ ()
 Advance the iterator to the next position.
 
MSetIterator operator++ (int)
 Advance the iterator to the next position (postfix version).
 
MSetIteratoroperator-- ()
 Move the iterator to the previous position.
 
MSetIterator operator-- (int)
 Move the iterator to the previous position (postfix version).
 
MSetIteratoroperator+= (difference_type n)
 Move the iterator forwards by n positions.
 
MSetIteratoroperator-= (difference_type n)
 Move the iterator back by n positions.
 
MSetIterator operator+ (difference_type n) const
 
MSetIterator operator- (difference_type n) const
 
difference_type operator- (const MSetIterator &o) const
 
Xapian::doccount get_rank () const
 
Xapian::Document get_document () const
 Get the Document object for the current position. More...
 
double get_weight () const
 Get the weight for the current position. More...
 
std::string get_collapse_key () const
 
Xapian::doccount get_collapse_count () const
 
int get_percent () const
 
std::string get_description () const
 Return a string describing this object.
 

Detailed Description

Iterator over a Xapian::MSet.

Constructor & Destructor Documentation

Xapian::MSetIterator::MSetIterator ( )
inline

Create an unpositioned MSetIterator.

Member Function Documentation

Xapian::Document Xapian::MSetIterator::get_document ( ) const

Get the Document object for the current position.

double Xapian::MSetIterator::get_weight ( ) const

Get the weight for the current position.

Referenced by Xapian::MSet::fetch().

Xapian::docid Xapian::MSetIterator::operator* ( ) const

Get the numeric document id for the current position.


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

Documentation for Xapian (version 1.4.0).
Generated on Wed Oct 12 2016 by Doxygen 1.8.11.