Xapian::FreqSource Class Reference

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

#include <cluster.h>

Inheritance diagram for Xapian::FreqSource:

Collaboration diagram for Xapian::FreqSource:

Public Member Functions
	FreqSource ()
	Default constructor. More...
virtual	~FreqSource ()
	Destructor. More...
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. More...
FreqSource *	release ()
	Start reference counting this object. More...
const FreqSource *	release () const
	Start reference counting this object. More...
Public Member Functions inherited from Xapian::Internal::opt_intrusive_base
	opt_intrusive_base (const opt_intrusive_base &)
opt_intrusive_base &	operator= (const opt_intrusive_base &)
	opt_intrusive_base ()
	Construct object which is initially not reference counted. More...
virtual	~opt_intrusive_base ()
void	ref () const
void	unref () const

Private Member Functions
void	operator= (const FreqSource &)=delete
	Don't allow assignment. More...
	FreqSource (const FreqSource &)=delete
	Don't allow copying. More...

Additional Inherited Members
Public Attributes inherited from Xapian::Internal::opt_intrusive_base
unsigned	_refs
	Reference count. More...
Protected Member Functions inherited from Xapian::Internal::opt_intrusive_base
void	release () const
	Start reference counting. More...

Detailed Description

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

Definition at line 135 of file cluster.h.

Constructor & Destructor Documentation

FreqSource() [1/2]

Xapian::FreqSource::FreqSource ( const FreqSource &  )

privatedelete

Don't allow copying.

FreqSource() [2/2]

Xapian::FreqSource::FreqSource ( )

inline

Default constructor.

Definition at line 145 of file cluster.h.

~FreqSource()

virtual Xapian::FreqSource::~FreqSource ( )

virtual

Destructor.

Member Function Documentation

get_doccount()

virtual doccount Xapian::FreqSource::get_doccount ( ) const

pure virtual

Return the number of documents within the MSet.

Implemented in Xapian::TermListGroup.

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

tname

The term for which to return the term frequency

Implemented in Xapian::TermListGroup.

operator=()

void Xapian::FreqSource::operator= ( const FreqSource &  )

privatedelete

Don't allow assignment.

release() [1/2]

FreqSource* Xapian::FreqSource::release ( )

inline

Start reference counting this object.

You can transfer 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.

Definition at line 166 of file cluster.h.

release() [2/2]

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

inline

Start reference counting this object.

You can transfer 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.

Definition at line 178 of file cluster.h.

---

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

• include/xapian/cluster.h