Xapian: API Documentation: xapian-core: Xapian::PositionIterator Class Reference

# Xapian::PositionIterator Class Reference

An iterator pointing to items in a list of positions. More...

List of all members.

## Public Member Functions
| 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.
void | skip_to (Xapian::termpos pos)
| Advance the iterator to the specified termpos.
std::string | get_description () const
| Return a string describing this object.
## Friends
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.

## Constructor & Destructor Documentation

Xapian::PositionIterator::PositionIterator | ( | const PositionIterator & | o | ) |

Copying is allowed.

The internals are reference counted, so copying is also cheap.

## Member Function Documentation

void Xapian::PositionIterator::operator= | ( | const PositionIterator & | o | ) |

Assignment is allowed.

The internals are reference counted, so assignment is also cheap.

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

The documentation for this class was generated from the following file:

- xapian/positioniterator.h