#include <enquire.h>
Inheritance diagram for Xapian::BoolWeight:
Public Member Functions | |
| BoolWeight * | clone () const |
| Return a new weight object of this type. | |
| BoolWeight () | |
| ~BoolWeight () | |
| std::string | name () const |
| Name of the weighting scheme. | |
| std::string | serialise () const |
| Serialise object parameters into a string. | |
| BoolWeight * | unserialise (const std::string &s) const |
| Create object given string serialisation returned by serialise(). | |
| Xapian::weight | get_sumpart (Xapian::termcount wdf, Xapian::doclength len) const |
| Get a weight which is part of the sum over terms being performed. | |
| Xapian::weight | get_maxpart () const |
| Gets the maximum value that get_sumpart() may return. | |
| 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. | |
| Xapian::weight | get_maxextra () const |
| Gets the maximum value that get_sumextra() may return. | |
| bool | get_sumpart_needs_doclength () const |
| return false if the weight object doesn't need doclength | |
Definition at line 1148 of file enquire.h.
| BoolWeight * Xapian::BoolWeight::clone | ( | ) | const [virtual] |
Return a new weight object of this type.
A subclass called FooWeight taking parameters param1 and param2 should implement this as:
virtual FooWeight * clone() const { return new FooWeight(param1, param2); }
Implements Xapian::Weight.
| std::string Xapian::BoolWeight::name | ( | ) | const [virtual] |
Name of the weighting scheme.
If the subclass is called FooWeight, this should return "Foo".
Implements Xapian::Weight.
Definition at line 55 of file weight.cc.
Referenced by DEFINE_TESTCASE().
| std::string Xapian::BoolWeight::serialise | ( | ) | const [virtual] |
Serialise object parameters into a string.
Implements Xapian::Weight.
Definition at line 57 of file weight.cc.
Referenced by DEFINE_TESTCASE().
| BoolWeight * Xapian::BoolWeight::unserialise | ( | const std::string & | s | ) | const [virtual] |
| Xapian::weight Xapian::BoolWeight::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.
| wdf | the within document frequency of the term. | |
| len | the (unnormalised) document length. |
Implements Xapian::Weight.
| Xapian::weight Xapian::BoolWeight::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::BoolWeight::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.
| len | the (unnormalised) document length. |
Implements Xapian::Weight.
| Xapian::weight Xapian::BoolWeight::get_maxextra | ( | ) | const [virtual] |
Gets the maximum value that get_sumextra() may return.
This is used in optimising searches.
Implements Xapian::Weight.
| bool Xapian::BoolWeight::get_sumpart_needs_doclength | ( | ) | const [virtual] |