xapian-core  1.5.0_git3738
Public Member Functions | List of all members
Xapian::RSet Class Reference

Class representing a set of documents judged as relevant. More...

Public Member Functions

 RSet (const RSet &o)
 Copying is allowed. More...
 
RSetoperator= (const RSet &o)
 Copying is allowed. More...
 
 RSet (RSet &&o)
 Move constructor.
 
RSetoperator= (RSet &&o)
 Move assignment operator.
 
 RSet ()
 Default constructor. More...
 
 ~RSet ()
 Destructor.
 
Xapian::doccount size () const
 Return number of documents in this RSet object. More...
 
bool empty () const
 Return true if this RSet object is empty. More...
 
void swap (RSet &o)
 Efficiently swap this RSet object with another. More...
 
void add_document (Xapian::docid did)
 Mark a document as relevant. More...
 
void add_document (const Xapian::MSetIterator &it)
 Mark a document as relevant. More...
 
void remove_document (Xapian::docid did)
 Unmark a document as relevant. More...
 
void remove_document (const Xapian::MSetIterator &it)
 Unmark a document as relevant. More...
 
bool contains (Xapian::docid did) const
 Check if a document is marked as relevant.
 
bool contains (const Xapian::MSetIterator &it) const
 Check if a document is marked as relevant.
 
std::string get_description () const
 Return a string describing this object.
 

Detailed Description

Class representing a set of documents judged as relevant.

Constructor & Destructor Documentation

◆ RSet() [1/2]

Xapian::RSet::RSet ( const RSet o)

Copying is allowed.

The internals are reference counted, so copying is cheap.

◆ RSet() [2/2]

Xapian::RSet::RSet ( )

Default constructor.

Creates an empty RSet.

Member Function Documentation

◆ add_document() [1/2]

void Xapian::RSet::add_document ( Xapian::docid  did)

Mark a document as relevant.

If did is already marked as relevant, nothing happens.

◆ add_document() [2/2]

void Xapian::RSet::add_document ( const Xapian::MSetIterator it)
inline

Mark a document as relevant.

If did is already marked as relevant, nothing happens.

◆ empty()

bool Xapian::RSet::empty ( ) const
inline

Return true if this RSet object is empty.

◆ operator=()

RSet& Xapian::RSet::operator= ( const RSet o)

Copying is allowed.

The internals are reference counted, so assignment is cheap.

◆ remove_document() [1/2]

void Xapian::RSet::remove_document ( Xapian::docid  did)

Unmark a document as relevant.

If did is not marked as relevant, nothing happens.

◆ remove_document() [2/2]

void Xapian::RSet::remove_document ( const Xapian::MSetIterator it)
inline

Unmark a document as relevant.

If did is not marked as relevant, nothing happens.

◆ size()

Xapian::doccount Xapian::RSet::size ( ) const

Return number of documents in this RSet object.

◆ swap()

void Xapian::RSet::swap ( RSet o)
inline

Efficiently swap this RSet object with another.


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