xapian-core  1.4.21
Public Member Functions | Public Attributes | Private Attributes | List of all members
Xapian::Internal::ExpandStats Class Reference

Collates statistics while calculating term weight in an ESet. More...

#include <expandweight.h>

+ Collaboration diagram for Xapian::Internal::ExpandStats:

Public Member Functions

 ExpandStats (Xapian::doclength avlen_)
 Constructor for expansion schemes which do not require the "expand_k" parameter. More...
 
 ExpandStats (Xapian::doclength avlen_, double expand_k_)
 Constructor for expansion schemes which require the "expand_k" parameter. More...
 
void accumulate (size_t shard_index, Xapian::termcount wdf, Xapian::termcount doclen, Xapian::doccount subtf, Xapian::doccount subdbsize)
 
void clear_stats ()
 

Public Attributes

Xapian::doccount dbsize
 Size of the subset of a multidb to which the value in termfreq applies. More...
 
Xapian::doccount termfreq
 Term frequency (for a multidb, may be for a subset of the databases). More...
 
Xapian::termcount rcollection_freq
 The number of times the term occurs in the rset. More...
 
Xapian::doccount rtermfreq
 The number of documents from the RSet indexed by the current term (r). More...
 
double multiplier
 The multiplier to be used in TradWeight query expansion. More...
 

Private Attributes

std::vector< bool > dbs_seen
 Which databases in a multidb are included in termfreq. More...
 
Xapian::doclength avlen
 Average document length in the whole database. More...
 
double expand_k
 The parameter k to be used for TradWeight query expansion. More...
 

Detailed Description

Collates statistics while calculating term weight in an ESet.

Definition at line 37 of file expandweight.h.

Constructor & Destructor Documentation

◆ ExpandStats() [1/2]

Xapian::Internal::ExpandStats::ExpandStats ( Xapian::doclength  avlen_)
inlineexplicit

Constructor for expansion schemes which do not require the "expand_k" parameter.

Definition at line 65 of file expandweight.h.

◆ ExpandStats() [2/2]

Xapian::Internal::ExpandStats::ExpandStats ( Xapian::doclength  avlen_,
double  expand_k_ 
)
inline

Constructor for expansion schemes which require the "expand_k" parameter.

Definition at line 71 of file expandweight.h.

Member Function Documentation

◆ accumulate()

void Xapian::Internal::ExpandStats::accumulate ( size_t  shard_index,
Xapian::termcount  wdf,
Xapian::termcount  doclen,
Xapian::doccount  subtf,
Xapian::doccount  subdbsize 
)
inline

◆ clear_stats()

void Xapian::Internal::ExpandStats::clear_stats ( )
inline

Definition at line 102 of file expandweight.h.

Member Data Documentation

◆ avlen

Xapian::doclength Xapian::Internal::ExpandStats::avlen
private

Average document length in the whole database.

Definition at line 42 of file expandweight.h.

Referenced by Xapian::Internal::ExpandWeight::get_avlen().

◆ dbs_seen

std::vector<bool> Xapian::Internal::ExpandStats::dbs_seen
private

Which databases in a multidb are included in termfreq.

Definition at line 39 of file expandweight.h.

◆ dbsize

Xapian::doccount Xapian::Internal::ExpandStats::dbsize

Size of the subset of a multidb to which the value in termfreq applies.

Definition at line 49 of file expandweight.h.

Referenced by Xapian::Internal::ExpandWeight::get_dbsize().

◆ expand_k

double Xapian::Internal::ExpandStats::expand_k
private

The parameter k to be used for TradWeight query expansion.

Definition at line 45 of file expandweight.h.

◆ multiplier

double Xapian::Internal::ExpandStats::multiplier

The multiplier to be used in TradWeight query expansion.

Definition at line 61 of file expandweight.h.

◆ rcollection_freq

Xapian::termcount Xapian::Internal::ExpandStats::rcollection_freq

The number of times the term occurs in the rset.

Definition at line 55 of file expandweight.h.

◆ rtermfreq

Xapian::doccount Xapian::Internal::ExpandStats::rtermfreq

The number of documents from the RSet indexed by the current term (r).

Definition at line 58 of file expandweight.h.

Referenced by accumulate().

◆ termfreq

Xapian::doccount Xapian::Internal::ExpandStats::termfreq

Term frequency (for a multidb, may be for a subset of the databases).

Definition at line 52 of file expandweight.h.


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