strus  0.17
Public Member Functions | List of all members
strus::TermStatistics Class Reference

Global term statistics, if passed down with the query. More...

#include <termStatistics.hpp>

Public Member Functions

 TermStatistics ()
 Constructor. More...
 
 TermStatistics (const GlobalCounter &df_)
 Constructor. More...
 
 TermStatistics (const TermStatistics &o)
 Copy constructor. More...
 
GlobalCounter documentFrequency () const
 Get the global document frequency. More...
 
void setDocumentFrequency (const GlobalCounter &df_)
 Set the global document frequency to use for the associated term. More...
 

Detailed Description

Global term statistics, if passed down with the query.

Note
If values of this structure is undefined, then the value stored is used

Constructor & Destructor Documentation

strus::TermStatistics::TermStatistics ( )
inline

Constructor.

strus::TermStatistics::TermStatistics ( const GlobalCounter df_)
inline

Constructor.

strus::TermStatistics::TermStatistics ( const TermStatistics o)
inline

Copy constructor.

Member Function Documentation

GlobalCounter strus::TermStatistics::documentFrequency ( ) const
inline

Get the global document frequency.

Returns
the global document frequency or -1 for undefined, if undefined then the value cache for the global dfs in the document frequency or what is stored in the local storage)
void strus::TermStatistics::setDocumentFrequency ( const GlobalCounter df_)
inline

Set the global document frequency to use for the associated term.

Parameters
[in]df_the global document frequency value

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