Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

OmRSet Class Reference

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

#include <omenquire.h>

List of all members.

Public Methods

 OmRSet (const OmRSet &rset)
 Copy constructor. More...

void operator= (const OmRSet &rset)
 Assignment operator. More...

 OmRSet ()
 Default constructor. More...

 ~OmRSet ()
 Destructor. More...

om_doccount size () const
 The number of documents in this R-Set. More...

bool empty () const
 Test if this R-Set is empty. More...

void add_document (om_docid did)
 Add a document to the relevance set. More...

void add_document (const OmMSetIterator &i)
 Add a document to the relevance set. More...

void remove_document (om_docid did)
 Remove a document from the relevance set. More...

void remove_document (const OmMSetIterator &i)
 Remove a document from the relevance set. More...

bool contains (om_docid did) const
 Test if a given document in the relevance set. More...

bool contains (const OmMSetIterator &i)
 Test if a given document in the relevance set. More...

std::string get_description () const
 Introspection method. More...


Public Attributes

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.


Constructor & Destructor Documentation

OmRSet::OmRSet const OmRSet &    rset
 

Copy constructor.

OmRSet::OmRSet  
 

Default constructor.

OmRSet::~OmRSet  
 

Destructor.


Member Function Documentation

void OmRSet::add_document const OmMSetIterator   i [inline]
 

Add a document to the relevance set.

void OmRSet::add_document om_docid    did
 

Add a document to the relevance set.

bool OmRSet::contains const OmMSetIterator   i [inline]
 

Test if a given document in the relevance set.

bool OmRSet::contains om_docid    did const
 

Test if a given document in the relevance set.

bool OmRSet::empty   const
 

Test if this R-Set is empty.

std::string OmRSet::get_description   const
 

Introspection method.

Returns:
A string representing this OmRSet.

void OmRSet::operator= const OmRSet &    rset
 

Assignment operator.

void OmRSet::remove_document const OmMSetIterator   i [inline]
 

Remove a document from the relevance set.

void OmRSet::remove_document om_docid    did
 

Remove a document from the relevance set.

om_doccount OmRSet::size   const
 

The number of documents in this R-Set.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.4.1cvs).
Generated on 20 Sep 2002 by Doxygen 1.2.15.