Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

Xapian::TradWeight Class Reference

Traditional probabilistic weighting scheme (as used by Muscat 3.6). More...

#include <enquire.h>

Inheritance diagram for Xapian::TradWeight:

Inheritance graph
[legend]
Collaboration diagram for Xapian::TradWeight:

Collaboration graph
[legend]
List of all members.

Public Methods

 TradWeight (double k=1)
 Construct a TradWeight. More...

Weightclone () const
 Return a new weight object of this type. More...

 ~TradWeight ()
std::string name () const
 Name of the weighting scheme. More...

std::string serialise () const
 Serialise object parameters into a string. More...

Weightunserialise (const std::string &s) const
Xapian::weight get_sumpart (Xapian::termcount wdf, Xapian::doclength len) const
 Get a weight which is part of the sum over terms being performed. More...

Xapian::weight get_maxpart () const
 Gets the maximum value that get_sumpart() may return. More...

Xapian::weight get_sumextra (Xapian::doclength len) const
 Get an extra weight for a document to add to the sum calculated over the query terms. More...

Xapian::weight get_maxextra () const
 Gets the maximum value that get_sumextra() may return. More...

bool get_sumpart_needs_doclength () const
 return false if the weight object doesn't need doclength. More...


Detailed Description

Traditional probabilistic weighting scheme (as used by Muscat 3.6).


Constructor & Destructor Documentation

Xapian::TradWeight::TradWeight double    k = 1 [inline]
 

Construct a TradWeight.


Member Function Documentation

Weight* Xapian::TradWeight::clone   const [inline, virtual]
 

Return a new weight object of this type.

Implements Xapian::Weight.

Xapian::weight Xapian::TradWeight::get_maxextra   const [virtual]
 

Gets the maximum value that get_sumextra() may return.

This is used in optimising searches.

Implements Xapian::Weight.

Xapian::weight Xapian::TradWeight::get_maxpart   const [virtual]
 

Gets the maximum value that get_sumpart() may return.

This is used in optimising searches, by having the postlist tree decay appropriately when parts of it can have limited, or no, further effect.

Implements Xapian::Weight.

Xapian::weight Xapian::TradWeight::get_sumextra Xapian::doclength    len const [virtual]
 

Get an extra weight for a document to add to the sum calculated over the query terms.

This returns a weight for a given document, and is used by some weighting schemes to account for influence such as document length.

Parameters:
len  the (unnormalised) document length.

Implements Xapian::Weight.

Xapian::weight Xapian::TradWeight::get_sumpart Xapian::termcount    wdf,
Xapian::doclength    len
const [virtual]
 

Get a weight which is part of the sum over terms being performed.

This returns a weight for a given term and document. These weights are summed to give a total weight for the document.

Parameters:
wdf  the within document frequency of the term.
len  the (unnormalised) document length.

Implements Xapian::Weight.

bool Xapian::TradWeight::get_sumpart_needs_doclength   const [inline, virtual]
 

return false if the weight object doesn't need doclength.

Reimplemented from Xapian::Weight.

std::string Xapian::TradWeight::name   const [inline, virtual]
 

Name of the weighting scheme.

Implements Xapian::Weight.

std::string Xapian::TradWeight::serialise   const [virtual]
 

Serialise object parameters into a string.

Implements Xapian::Weight.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.7.2).
Generated on 8 Aug 2003 by Doxygen 1.2.15.