Xapian::Weight::Internal

Xapian::Weight::Internal Class Reference

Class to hold statistics for a given collection. More...

#include <weightinternal.h>

List of all members.

Public Member Functions

 Internal (const Stats &stats)
 Create a Weight::Internal object with global statistics.
 Internal (const Stats &stats, const std::string &tname)
 Create a Weight::Internal object with global and term statistics.

Public Attributes

Xapian::doccount collection_size
 Number of documents in the collection.
Xapian::doccount rset_size
 Number of relevant documents in the collection.
Xapian::doclength average_length
 Average length of documents in the collection.
Xapian::doccount termfreq
 Term frequency.
Xapian::doccount reltermfreq
 Relevant term frequency.

Detailed Description

Class to hold statistics for a given collection.

Definition at line 31 of file weightinternal.h.

Constructor & Destructor Documentation

Xapian::Weight::Internal::Internal ( const Stats &  stats  ) 

Create a Weight::Internal object with global statistics.

All term-specific statistics will be set to 0.

Parameters:
stats Object containing the statistics to use.

Definition at line 28 of file weightinternal.cc.

Xapian::Weight::Internal::Internal ( const Stats &  stats,
const std::string &  tname 
)

Create a Weight::Internal object with global and term statistics.

Parameters:
stats Object containing the statistics to use.
tname The term to read the term-specific statistics for.

Member Data Documentation

Xapian::doccount Xapian::Weight::Internal::collection_size

Number of documents in the collection.

Definition at line 34 of file weightinternal.h.

Referenced by Xapian::TradWeight::calc_termweight(), and Xapian::BM25Weight::calc_termweight().

Xapian::doccount Xapian::Weight::Internal::rset_size

Number of relevant documents in the collection.

Definition at line 37 of file weightinternal.h.

Referenced by Xapian::TradWeight::calc_termweight(), and Xapian::BM25Weight::calc_termweight().

Xapian::doclength Xapian::Weight::Internal::average_length

Average length of documents in the collection.

Definition at line 40 of file weightinternal.h.

Xapian::doccount Xapian::Weight::Internal::termfreq

Term frequency.

ie, number of documents that the term for this weight object occurs in.

Definition at line 47 of file weightinternal.h.

Xapian::doccount Xapian::Weight::Internal::reltermfreq

Relevant term frequency.

ie, number of relevant documents that the term for this weight object occurs in.

Definition at line 54 of file weightinternal.h.

The documentation for this class was generated from the following files:
Documentation for Xapian (version 1.0.10).
Generated on 24 Dec 2008 by Doxygen 1.5.2.