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 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
 Introspection method.

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

Xapian::termcount Xapian::ESet::max_size  )  const [inline]
 

Required to allow use as an STL container.

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

Assignment is allowed (and is cheap).

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

This returns the term 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.9.6).
Generated on 15 May 2006 by Doxygen 1.4.6.