Xapian::ESet Class Reference

Class representing an ordered set of expand terms (an ESet). More...

#include <enquire.h>

Collaboration diagram for Xapian::ESet:

[legend]List of all members.

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
	For internal use only. Reference counted internals.
Classes
class	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 390 of file enquire.h.

---

Constructor & Destructor Documentation

Xapian::ESet::ESet

(

)

Construct an empty ESet.

Definition at line 448 of file omenquire.cc.

Xapian::ESet::~ESet

(

)

Destructor.

Definition at line 450 of file omenquire.cc.

Xapian::ESet::ESet

(

const ESet &

other

)

Copying is allowed (and is cheap).

Definition at line 454 of file omenquire.cc.

---

Member Function Documentation

void Xapian::ESet::operator=

(

const ESet &

other

)

Assignment is allowed (and is cheap).

Definition at line 459 of file omenquire.cc.

References internal.

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 465 of file omenquire.cc.

Xapian::termcount Xapian::ESet::size

(

)

const

The number of terms in this E-Set.

Definition at line 471 of file omenquire.cc.

Referenced by DEFINE_TESTCASE(), and operator[]().

Xapian::termcount Xapian::ESet::max_size

(

)

const [inline]

Required to allow use as an STL container.

Definition at line 418 of file enquire.h.

References size.

bool Xapian::ESet::empty

(

)

const

Test if this E-Set is empty.

Definition at line 477 of file omenquire.cc.

Referenced by back().

void Xapian::ESet::swap

(

ESet &

other

)

Swap the E-Set we point to with another.

Definition at line 483 of file omenquire.cc.

References internal.

ESetIterator Xapian::ESet::begin

(

)

const

Iterator for the terms in this E-Set.

Definition at line 489 of file omenquire.cc.

Referenced by DEFINE_TESTCASE(), and main().

ESetIterator Xapian::ESet::end

(

)

const

End iterator corresponding to begin().

Definition at line 495 of file omenquire.cc.

References Assert, and internal.

Referenced by DEFINE_TESTCASE(), and main().

ESetIterator Xapian::ESet::back

(

)

const

Iterator pointing to the last element of this E-Set.

Definition at line 510 of file omenquire.cc.

References Assert, empty(), and internal.

ESetIterator Xapian::ESet::operator[]

(

Xapian::termcount

i

)

const

This returns the term at position i in this E-Set.

Definition at line 502 of file omenquire.cc.

References Assert, and size().

string Xapian::ESet::get_description

(

)

const

Return a string describing this object.

Definition at line 518 of file omenquire.cc.

References Assert.

---

Member Data Documentation

Xapian::Internal::RefCntPtr<Internal> Xapian::ESet::internal

For internal use only.

Reference counted internals.

Definition at line 392 of file enquire.h.

Referenced by back(), end(), OmExpand::expand(), 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

---