xapian-core  1.5.0
Public Member Functions | List of all members
Xapian::FreqSource Class Referenceabstract

Base class for TermListGroup Stores and provides terms that are contained in a document and their respective term frequencies. More...

+ Inheritance diagram for Xapian::FreqSource:

Public Member Functions

 FreqSource ()
 Default constructor.
 
virtual ~FreqSource ()
 Destructor.
 
virtual doccount get_termfreq (const std::string &tname) const =0
 Return the term frequency of a particular term 'tname'. More...
 
virtual doccount get_doccount () const =0
 Return the number of documents within the MSet.
 
FreqSourcerelease ()
 Start reference counting this object. More...
 
const FreqSourcerelease () const
 Start reference counting this object. More...
 

Detailed Description

Base class for TermListGroup Stores and provides terms that are contained in a document and their respective term frequencies.

Member Function Documentation

◆ get_termfreq()

virtual doccount Xapian::FreqSource::get_termfreq ( const std::string &  tname) const
pure virtual

Return the term frequency of a particular term 'tname'.

Parameters
tnameThe term for which to return the term frequency

Implemented in Xapian::TermListGroup.

◆ release() [1/2]

FreqSource* Xapian::FreqSource::release ( )
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated FreqSource object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

◆ release() [2/2]

const FreqSource* Xapian::FreqSource::release ( ) const
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated FreqSource object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.


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