Public Types | |
| typedef std::input_iterator_tag | iterator_category |
| Allow use as an STL iterator. | |
| typedef std::string | value_type |
| Allow use as an STL iterator. | |
| typedef Xapian::termcount_diff | difference_type |
| Allow use as an STL iterator. | |
| typedef std::string * | pointer |
| Allow use as an STL iterator. | |
| typedef std::string & | reference |
| Allow use as an STL iterator. | |
Public Member Functions | |
| TermIterator () | |
| Default constructor - for declaring an uninitialised iterator. | |
| ~TermIterator () | |
| Destructor. | |
| TermIterator (const TermIterator &other) | |
| Copying is allowed. | |
| void | operator= (const TermIterator &other) |
| Assignment is allowed. | |
| std::string | operator* () const |
| Return the current term. | |
| void | skip_to (const std::string &tname) |
| Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. | |
| Xapian::termcount | get_wdf () const |
| Return the wdf of the current term (if meaningful). | |
| Xapian::doccount | get_termfreq () const |
| Return the term frequency of the current term (if meaningful). | |
| Xapian::termcount | positionlist_count () const |
| Return length of positionlist for current term. | |
| PositionIterator | positionlist_begin () const |
| Return PositionIterator pointing to start of positionlist for current term. | |
| PositionIterator | positionlist_end () const |
| Return PositionIterator pointing to end of positionlist for current term. | |
| std::string | get_description () const |
| Return a string describing this object. | |
| Xapian::TermIterator::TermIterator | ( | const TermIterator & | other | ) |
Copying is allowed.
The internals are reference counted, so copying is also cheap.
| Xapian::doccount Xapian::TermIterator::get_termfreq | ( | ) | const |
Return the term frequency of the current term (if meaningful).
The term frequency is the number of documents which a term indexes.
| Xapian::termcount Xapian::TermIterator::get_wdf | ( | ) | const |
Return the wdf of the current term (if meaningful).
The wdf (within document frequency) is the number of occurences of a term in a particular document.
| void Xapian::TermIterator::operator= | ( | const TermIterator & | other | ) |
Assignment is allowed.
The internals are reference counted, so assignment is also cheap.