Xapian::PositionIterator Class Reference

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

#include <positioniterator.h>

Collaboration diagram for Xapian::PositionIterator:

[legend]List of all members.

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++ ()
TermPosWrapper	operator++ (int)
void	skip_to (Xapian::termpos pos)
std::string	get_description () const
	Return a string describing this object.
Private Attributes
Xapian::Internal::RefCntPtr< Internal >	internal
	For internal use only. Reference counted internals.
Friends
class	PostingIterator
class	TermIterator
class	Database
bool	operator== (const PositionIterator &a, const PositionIterator &b)
	Test equality of two PositionIterators.
Classes
class	Internal
	Abstract base class for position lists. More...

---

Detailed Description

An iterator pointing to items in a list of positions.

Definition at line 53 of file positioniterator.h.

---

Member Typedef Documentation

typedef std::input_iterator_tag Xapian::PositionIterator::iterator_category

Definition at line 103 of file positioniterator.h.

typedef Xapian::termpos Xapian::PositionIterator::value_type

Definition at line 104 of file positioniterator.h.

typedef Xapian::termpos_diff Xapian::PositionIterator::difference_type

Definition at line 105 of file positioniterator.h.

typedef Xapian::termpos* Xapian::PositionIterator::pointer

Definition at line 106 of file positioniterator.h.

typedef Xapian::termpos& Xapian::PositionIterator::reference

Definition at line 107 of file positioniterator.h.

---

Constructor & Destructor Documentation

Xapian::PositionIterator::PositionIterator

(

Internal *

internal_

)

[explicit]

Definition at line 28 of file ompositionlistiterator.cc.

References internal.

Xapian::PositionIterator::PositionIterator

(

)

Default constructor - for declaring an uninitialised iterator.

Definition at line 37 of file ompositionlistiterator.cc.

Xapian::PositionIterator::~PositionIterator

(

)

Destructor.

Definition at line 46 of file ompositionlistiterator.cc.

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

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.

Xapian::termpos Xapian::PositionIterator::operator *

(

)

const

Definition at line 57 of file ompositionlistiterator.cc.

References Assert, DEBUGAPICALL, internal, and RETURN.

Xapian::PositionIterator & Xapian::PositionIterator::operator++

(

)

Definition at line 66 of file ompositionlistiterator.cc.

References Assert, DEBUGAPICALL, and internal.

TermPosWrapper Xapian::PositionIterator::operator++

(

int

)

[inline]

Definition at line 90 of file positioniterator.h.

void Xapian::PositionIterator::skip_to

(

Xapian::termpos

pos

)

Definition at line 78 of file ompositionlistiterator.cc.

References Assert, DEBUGAPICALL, and internal.

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.

---

Friends And Related Function Documentation

friend class PostingIterator [friend]

Definition at line 56 of file positioniterator.h.

friend class TermIterator [friend]

Definition at line 57 of file positioniterator.h.

friend class Database [friend]

Definition at line 58 of file positioniterator.h.

bool operator==	(	const PositionIterator &	a,
		const PositionIterator &	b
	)			[friend]

Test equality of two PositionIterators.

Definition at line 112 of file positioniterator.h.

---

Member Data Documentation

Xapian::Internal::RefCntPtr<Internal> Xapian::PositionIterator::internal [private]

For internal use only.

Reference counted internals.

Definition at line 61 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

---