Xapian::ESet Class Reference
Class representing an ordered set of expand terms (an ESet). More...
#include <enquire.h>
Classes | |
| class | Internal |
| Class which actually implements Xapian::ESet. More... | |
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. | |
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().
Definition at line 424 of file enquire.h.
Constructor & Destructor Documentation
| Xapian::ESet::ESet | ( | ) |
| Xapian::ESet::~ESet | ( | ) |
| Xapian::ESet::ESet | ( | const ESet & | other | ) |
Member Function Documentation
| ESetIterator Xapian::ESet::back | ( | ) | const |
Iterator pointing to the last element of this E-Set.
Definition at line 528 of file omenquire.cc.
References Assert, empty(), and internal.
Referenced by DEFINE_TESTCASE().
| ESetIterator Xapian::ESet::begin | ( | ) | const |
Iterator for the terms in this E-Set.
Definition at line 507 of file omenquire.cc.
Referenced by DEFINE_TESTCASE(), and main().
| bool Xapian::ESet::empty | ( | ) | const |
| ESetIterator Xapian::ESet::end | ( | ) | const |
End iterator corresponding to begin().
Definition at line 513 of file omenquire.cc.
References Assert, and internal.
Referenced by DEFINE_TESTCASE(), and main().
| string Xapian::ESet::get_description | ( | ) | const |
Return a string describing this object.
Definition at line 536 of file omenquire.cc.
References Assert.
Referenced by DEFINE_TESTCASE().
| 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()
Definition at line 483 of file omenquire.cc.
| Xapian::termcount Xapian::ESet::max_size | ( | ) | const [inline] |
| void Xapian::ESet::operator= | ( | const ESet & | other | ) |
Assignment is allowed (and is cheap).
Definition at line 477 of file omenquire.cc.
References internal.
| ESetIterator Xapian::ESet::operator[] | ( | Xapian::termcount | i | ) | const |
This returns the term at position i in this E-Set.
- Parameters:
-
i The index into the ESet.
Definition at line 520 of file omenquire.cc.
| Xapian::termcount Xapian::ESet::size | ( | ) | const |
The number of terms in this E-Set.
Definition at line 489 of file omenquire.cc.
Referenced by DEFINE_TESTCASE(), and operator[]().
| void Xapian::ESet::swap | ( | ESet & | other | ) |
Swap the E-Set we point to with another.
Definition at line 501 of file omenquire.cc.
References internal.
Member Data Documentation
For internal use only.
Reference counted internals.
Definition at line 426 of file enquire.h.
Referenced by back(), end(), Xapian::ESetIterator::get_weight(), Xapian::ESetIterator::operator*(), operator=(), and swap().
The documentation for this class was generated from the following files:
- include/xapian/enquire.h
- api/omenquire.cc