Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

Xapian::ESet Class Reference

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

#include <enquire.h>

Collaboration diagram for Xapian::ESet:

Collaboration graph
[legend]
List of all members.

Public Methods

 ESet ()
 Construct an empty ESet. More...

 ~ESet ()
 Destructor. More...

 ESet (const ESet &other)
 Copying is allowed (and is cheap). More...

void operator= (const ESet &other)
 Assignment is allowed (and is cheap). More...

Xapian::termcount get_ebound () const
 A lower bound on the number of terms which are in the full set of results of the expand. More...

Xapian::termcount size () const
 The number of terms in this E-Set. More...

bool empty () const
 Test if this E-Set is empty. More...

void swap (ESet &other)
 Swap the E-Set we point to with another. More...

ESetIterator begin () const
 Iterator for the terms in this E-Set. More...

ESetIterator end () const
 End iterator corresponding to begin(). More...

ESetIterator back () const
 Iterator pointing to the last element of this E-Set. More...

ESetIterator operator[] (Xapian::doccount i) const
 This returns the document at position i in this E-Set. More...

std::string get_description () const
 Introspection method. More...


Public Attributes

Xapian::Internal::RefCntPtr<
Internal > 
internal

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().


Constructor & Destructor Documentation

Xapian::ESet::ESet  
 

Construct an empty ESet.

Xapian::ESet::~ESet  
 

Destructor.

Xapian::ESet::ESet const ESet &    other
 

Copying is allowed (and is cheap).


Member Function Documentation

ESetIterator Xapian::ESet::back   const
 

Iterator pointing to the last element of this E-Set.

ESetIterator Xapian::ESet::begin   const
 

Iterator for the terms in this E-Set.

bool Xapian::ESet::empty   const
 

Test if this E-Set is empty.

ESetIterator Xapian::ESet::end   const
 

End iterator corresponding to begin().

std::string Xapian::ESet::get_description   const
 

Introspection method.

Returns:
A string representing this ESet.

Xapian::termcount Xapian::ESet::get_ebound   const
 

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()

void Xapian::ESet::operator= const ESet &    other
 

Assignment is allowed (and is cheap).

ESetIterator Xapian::ESet::operator[] Xapian::doccount    i const
 

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

Xapian::termcount Xapian::ESet::size   const
 

The number of terms in this E-Set.

void Xapian::ESet::swap ESet &    other
 

Swap the E-Set we point to with another.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.8.2).
Generated on 13 Sep 2004 by Doxygen 1.2.15.