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

A class for construction of termlists which store the terms for a document along with the number of documents it indexes i.e. More...

+ Inheritance diagram for Xapian::TermListGroup:

Public Member Functions

 TermListGroup (const MSet &docs, const Stopper *stopper=NULL)
 Constructor. More...
 
doccount get_termfreq (const std::string &tname) const
 Return the number of documents that the term 'tname' exists in. More...
 
doccount get_doccount () const
 Return the number of documents within the MSet.
 
- Public Member Functions inherited from Xapian::FreqSource
 FreqSource ()
 Default constructor.
 
virtual ~FreqSource ()
 Destructor.
 
FreqSourcerelease ()
 Start reference counting this object. More...
 
const FreqSourcerelease () const
 Start reference counting this object. More...
 

Detailed Description

A class for construction of termlists which store the terms for a document along with the number of documents it indexes i.e.

term frequency

Constructor & Destructor Documentation

◆ TermListGroup()

Xapian::TermListGroup::TermListGroup ( const MSet docs,
const Stopper stopper = NULL 
)
explicit

Constructor.

Parameters
docsMSet object used to construct the TermListGroup
stopperXapian::Stopper object to identify stopwords

Member Function Documentation

◆ get_termfreq()

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

Return the number of documents that the term 'tname' exists in.

Parameters
tnameThe term for which to return the term frequency

Implements Xapian::FreqSource.


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