Xapian::PositionIterator Class Reference
An iterator pointing to items in a list of positions. More...
#include <positioniterator.h>
Classes | |
| class | Internal |
| Abstract base class for position lists. More... | |
Public Types | |
| typedef std::input_iterator_tag | iterator_category |
| typedef Xapian::termpos | value_type |
| typedef Xapian::termpos_diff | difference_type |
| typedef Xapian::termpos * | pointer |
| typedef Xapian::termpos & | reference |
Public Member Functions | |
| PositionIterator (Internal *internal_) | |
| PositionIterator () | |
| Default constructor - for declaring an uninitialised iterator. | |
| ~PositionIterator () | |
| Destructor. | |
| PositionIterator (const PositionIterator &o) | |
| Copying is allowed. | |
| void | operator= (const PositionIterator &o) |
| Assignment is allowed. | |
| Xapian::termpos | operator* () const |
| PositionIterator & | operator++ () |
| DerefWrapper_< termpos > | operator++ (int) |
| void | skip_to (Xapian::termpos pos) |
| Advance the iterator to the specified termpos. | |
| std::string | get_description () const |
| Return a string describing this object. | |
Private Attributes | |
| Xapian::Internal::RefCntPtr < Internal > | internal |
Friends | |
| class | PostingIterator |
| class | TermIterator |
| class | Database |
| bool | operator== (const PositionIterator &a, const PositionIterator &b) |
| Test equality of two PositionIterators. | |
Detailed Description
An iterator pointing to items in a list of positions.Definition at line 43 of file positioniterator.h.
Member Typedef Documentation
Definition at line 100 of file positioniterator.h.
| typedef std::input_iterator_tag Xapian::PositionIterator::iterator_category |
Definition at line 98 of file positioniterator.h.
Definition at line 101 of file positioniterator.h.
Definition at line 102 of file positioniterator.h.
Definition at line 99 of file positioniterator.h.
Constructor & Destructor Documentation
| Xapian::PositionIterator::PositionIterator | ( | Internal * | internal_ | ) | [explicit] |
| Xapian::PositionIterator::PositionIterator | ( | ) |
Default constructor - for declaring an uninitialised iterator.
Definition at line 37 of file ompositionlistiterator.cc.
| Xapian::PositionIterator::~PositionIterator | ( | ) |
| Xapian::PositionIterator::PositionIterator | ( | const PositionIterator & | o | ) |
Copying is allowed.
The internals are reference counted, so copying is also cheap.
Definition at line 41 of file ompositionlistiterator.cc.
Member Function Documentation
| std::string Xapian::PositionIterator::get_description | ( | ) | const |
Return a string describing this object.
- Todo:
- display contents of the object
Definition at line 88 of file ompositionlistiterator.cc.
Referenced by DEFINE_TESTCASE().
| Xapian::termpos Xapian::PositionIterator::operator* | ( | ) | const |
| DerefWrapper_<termpos> Xapian::PositionIterator::operator++ | ( | int | ) | [inline] |
Definition at line 80 of file positioniterator.h.
| Xapian::PositionIterator & Xapian::PositionIterator::operator++ | ( | ) |
Definition at line 66 of file ompositionlistiterator.cc.
References Assert, internal, and LOGCALL_VOID.
| void Xapian::PositionIterator::operator= | ( | const PositionIterator & | o | ) |
Assignment is allowed.
The internals are reference counted, so assignment is also cheap.
Definition at line 51 of file ompositionlistiterator.cc.
References internal.
| void Xapian::PositionIterator::skip_to | ( | Xapian::termpos | pos | ) |
Advance the iterator to the specified termpos.
If the specified termpos isn't in the list, position ourselves on the first termpos after it (or at_end() if no greater term positions are present).
Definition at line 78 of file ompositionlistiterator.cc.
References Assert, internal, and LOGCALL_VOID.
Referenced by DEFINE_TESTCASE().
Friends And Related Function Documentation
friend class Database [friend] |
Definition at line 48 of file positioniterator.h.
| bool operator== | ( | const PositionIterator & | a, | |
| const PositionIterator & | b | |||
| ) | [friend] |
friend class PostingIterator [friend] |
Definition at line 46 of file positioniterator.h.
friend class TermIterator [friend] |
Definition at line 47 of file positioniterator.h.
Member Data Documentation
For internal use only.
Reference counted internals.
Definition at line 51 of file positioniterator.h.
Referenced by operator*(), operator++(), operator=(), Xapian::operator==(), PositionIterator(), and skip_to().
The documentation for this class was generated from the following files:
- include/xapian/positioniterator.h
- api/ompositionlistiterator.cc