Public Member Functions
Xapian::ESet Class Reference

Class representing an ordered set of expand terms (an ESet). More...

List of all members.

Public Member Functions

 ESet ()
 Construct an empty ESet.
 ~ESet ()
 Destructor.
 ESet (const ESet &other)
 Copying is allowed (and is cheap).
void operator= (const ESet &other)
 Assignment is allowed (and is cheap).
Xapian::termcount get_ebound () const
 A lower bound on the number of terms which are in the full set of results of the expand.
Xapian::termcount size () const
 The number of terms in this E-Set.
Xapian::termcount max_size () const
 Required to allow use as an STL container.
bool empty () const
 Test if this E-Set is empty.
void swap (ESet &other)
 Swap the E-Set we point to with another.
ESetIterator begin () const
 Iterator for the terms in this E-Set.
ESetIterator end () const
 End iterator corresponding to begin()
ESetIterator back () const
 Iterator pointing to the last element of this E-Set.
ESetIterator operator[] (Xapian::termcount i) const
 This returns the term at position i in this E-Set.
std::string get_description () const
 Return a string describing this object.

Detailed Description

Class representing an ordered set of expand terms (an ESet).

This set represents the results of an expand operation, which is performed by Xapian::Enquire::get_eset().


Member Function Documentation

A lower bound on the number of terms which are in the full set of results of the expand.

This will be greater than or equal to size()

Required to allow use as an STL container.

ESetIterator Xapian::ESet::operator[] ( Xapian::termcount  i) const

This returns the term at position i in this E-Set.

Parameters:
iThe index into the ESet.

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

Documentation for Xapian (version 1.3.1).
Generated on Fri May 3 2013 by Doxygen 1.7.6.1.