Xapian::RSet Class Reference
A relevance set (R-Set). More...
#include <enquire.h>
Classes | |
| class | Internal |
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 |
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 571 of file enquire.h.
Constructor & Destructor Documentation
| Xapian::RSet::RSet | ( | const RSet & | rset | ) |
| Xapian::RSet::RSet | ( | ) |
| Xapian::RSet::~RSet | ( | ) |
Member Function Documentation
| void Xapian::RSet::add_document | ( | const Xapian::MSetIterator & | i | ) | [inline] |
Add a document to the relevance set.
Definition at line 601 of file enquire.h.
References add_document().
Referenced by add_document().
| void Xapian::RSet::add_document | ( | Xapian::docid | did | ) |
Add a document to the relevance set.
Definition at line 93 of file omenquire.cc.
Referenced by DEFINE_TESTCASE(), main(), and unserialise_rset().
| bool Xapian::RSet::contains | ( | const Xapian::MSetIterator & | i | ) | const [inline] |
Test if a given document in the relevance set.
Definition at line 613 of file enquire.h.
References contains().
Referenced by contains().
| bool Xapian::RSet::contains | ( | Xapian::docid | did | ) | const |
| bool Xapian::RSet::empty | ( | ) | const |
Test if this R-Set is empty.
Definition at line 87 of file omenquire.cc.
Referenced by Xapian::build_termlist_tree(), DEFINE_TESTCASE(), Xapian::ESet::Internal::expand(), Xapian::Enquire::Internal::get_eset(), and main().
| string Xapian::RSet::get_description | ( | ) | const |
Return a string describing this object.
Definition at line 112 of file omenquire.cc.
Referenced by DEFINE_TESTCASE().
| void Xapian::RSet::operator= | ( | const RSet & | rset | ) |
| void Xapian::RSet::remove_document | ( | const Xapian::MSetIterator & | i | ) | [inline] |
Remove a document from the relevance set.
Definition at line 607 of file enquire.h.
References remove_document().
Referenced by remove_document().
| void Xapian::RSet::remove_document | ( | Xapian::docid | did | ) |
| Xapian::doccount Xapian::RSet::size | ( | ) | const |
The number of documents in this R-Set.
Definition at line 81 of file omenquire.cc.
Referenced by Xapian::Weight::Internal::accumulate_stats(), DEFINE_TESTCASE(), Xapian::Enquire::Internal::get_eset(), and unserialise_rset().
Member Data Documentation
For internal use only.
Reference counted internals.
Definition at line 574 of file enquire.h.
Referenced by Xapian::Weight::Internal::accumulate_stats(), Xapian::build_termlist_tree(), 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