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

Structure holding the statistics of a term to be used in a query. More...

#include <bindingObjects.hpp>

Public Member Functions

 TermStatistics ()
 Constructor. More...
 
 TermStatistics (GlobalCounter df_)
 Constructor. More...
 
 TermStatistics (const TermStatistics &o)
 Copy constructor. More...
 
GlobalCounter df () const
 Get the global document frequency. More...
 
void set_df (GlobalCounter df_)
 Set the global document frequency for a term in a query evaluation. More...
 

Detailed Description

Structure holding the statistics of a term to be used in a query.

Note
If values of this structure are undefined, then the storage values are used

Constructor & Destructor Documentation

strus::TermStatistics::TermStatistics ( )
inline

Constructor.

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

Constructor.

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

Copy constructor.

Member Function Documentation

GlobalCounter strus::TermStatistics::df ( ) 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::set_df ( GlobalCounter  df_)
inline

Set the global document frequency for a term in a query evaluation.

Parameters
[in]df_the document frequency value to use

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