Xapian::RSet Class Reference

A relevance set (R-Set). More...

#include <enquire.h>

Collaboration diagram for Xapian::RSet:

[legend]List of all members.

Public Member Functions
	RSet (const RSet &rset)
	Copy constructor.
void	operator= (const RSet &rset)
	Assignment operator.
	RSet ()
	Default constructor.
	~RSet ()
	Destructor.
Xapian::doccount	size () const
	The number of documents in this R-Set.
bool	empty () const
	Test if this R-Set is empty.
void	add_document (Xapian::docid did)
	Add a document to the relevance set.
void	add_document (const Xapian::MSetIterator &i)
	Add a document to the relevance set.
void	remove_document (Xapian::docid did)
	Remove a document from the relevance set.
void	remove_document (const Xapian::MSetIterator &i)
	Remove a document from the relevance set.
bool	contains (Xapian::docid did) const
	Test if a given document in the relevance set.
bool	contains (const Xapian::MSetIterator &i) const
	Test if a given document in the relevance 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

A relevance set (R-Set).

This is the set of documents which are marked as relevant, for use in modifying the term weights, and in performing query expansion.

Definition at line 534 of file enquire.h.

---

Constructor & Destructor Documentation

Xapian::RSet::RSet

(

const RSet &

rset

)

Copy constructor.

Definition at line 62 of file omenquire.cc.

Xapian::RSet::RSet

(

)

Default constructor.

Definition at line 58 of file omenquire.cc.

Xapian::RSet::~RSet

(

)

Destructor.

Definition at line 72 of file omenquire.cc.

---

Member Function Documentation

void Xapian::RSet::operator=

(

const RSet &

rset

)

Assignment operator.

Definition at line 67 of file omenquire.cc.

References internal.

Xapian::doccount Xapian::RSet::size

(

)

const

The number of documents in this R-Set.

Definition at line 77 of file omenquire.cc.

Referenced by Xapian::Enquire::Internal::get_eset(), and unserialise_rset().

bool Xapian::RSet::empty

(

)

const

Test if this R-Set is empty.

Definition at line 83 of file omenquire.cc.

Referenced by main().

void Xapian::RSet::add_document

(

Xapian::docid

did

)

Add a document to the relevance set.

Definition at line 89 of file omenquire.cc.

Referenced by DEFINE_TESTCASE(), main(), and unserialise_rset().

void Xapian::RSet::add_document

(

const Xapian::MSetIterator &

i

)

[inline]

Add a document to the relevance set.

Definition at line 564 of file enquire.h.

void Xapian::RSet::remove_document

(

Xapian::docid

did

)

Remove a document from the relevance set.

Definition at line 95 of file omenquire.cc.

void Xapian::RSet::remove_document

(

const Xapian::MSetIterator &

i

)

[inline]

Remove a document from the relevance set.

Definition at line 570 of file enquire.h.

bool Xapian::RSet::contains

(

Xapian::docid

did

)

const

Test if a given document in the relevance set.

Definition at line 101 of file omenquire.cc.

bool Xapian::RSet::contains

(

const Xapian::MSetIterator &

i

)

const [inline]

Test if a given document in the relevance set.

Definition at line 576 of file enquire.h.

string Xapian::RSet::get_description

(

)

const

Return a string describing this object.

Definition at line 107 of file omenquire.cc.

Referenced by DEFINE_TESTCASE().

---

Member Data Documentation

Xapian::Internal::RefCntPtr<Internal> Xapian::RSet::internal

For internal use only.

Reference counted internals.

Definition at line 537 of file enquire.h.

Referenced by operator=(), serialise_rset(), and split_rset_by_db().

---

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

• include/xapian/enquire.h
• api/omenquire.cc

---