Inheritance diagram for MyWeight:

Collaboration diagram for MyWeight:

Public Member Functions
MyWeight *	clone () const
	Clone this object. More...

void	init (double factor)
	Allow the subclass to perform any initialisation it needs to. More...

	MyWeight ()

	~MyWeight ()

std::string	name () const
	Return the name of this weighting scheme. More...

string	serialise () const
	Return this object's parameters serialised as a single string. More...

MyWeight *	unserialise (const string &) const
	Unserialise parameters. More...

double	get_sumpart (Xapian::termcount, Xapian::termcount, Xapian::termcount) const
	Calculate the weight contribution for this object's term to a document. More...

double	get_maxpart () const
	Return an upper bound on what get_sumpart() can return for any document. More...

double	get_sumextra (Xapian::termcount, Xapian::termcount) const
	Calculate the term-independent weight component for a document. More...

double	get_maxextra () const
	Return an upper bound on what get_sumextra() can return for any document. More...

Public Member Functions inherited from Xapian::Weight
	Weight ()
	Default constructor, needed by subclass constructors. More...

virtual	~Weight ()
	Virtual destructor, because we have virtual methods. More...

Private Attributes
double	scale_factor

Additional Inherited Members
Public Types inherited from Xapian::Weight
enum	type_smoothing { TWO_STAGE_SMOOTHING = 1, DIRICHLET_SMOOTHING = 2, ABSOLUTE_DISCOUNT_SMOOTHING = 3, JELINEK_MERCER_SMOOTHING = 4, DIRICHLET_PLUS_SMOOTHING = 5 }
	Type of smoothing to use with the Language Model Weighting scheme. More...

Protected Types inherited from Xapian::Weight
enum	stat_flags { COLLECTION_SIZE = 1, RSET_SIZE = 2, AVERAGE_LENGTH = 4, TERMFREQ = 8, RELTERMFREQ = 16, QUERY_LENGTH = 32, WQF = 64, WDF = 128, DOC_LENGTH = 256, DOC_LENGTH_MIN = 512, DOC_LENGTH_MAX = 1024, WDF_MAX = 2048, COLLECTION_FREQ = 4096, UNIQUE_TERMS = 8192, TOTAL_LENGTH = COLLECTION_SIZE \| AVERAGE_LENGTH }
	Stats which the weighting scheme can use (see need_stat()). More...

Protected Member Functions inherited from Xapian::Weight
void	need_stat (stat_flags flag)
	Tell Xapian that your subclass will want a particular statistic. More...

	Weight (const Weight &)
	Don't allow copying. More...

Xapian::doccount	get_collection_size () const
	The number of documents in the collection. More...

Xapian::doccount	get_rset_size () const
	The number of documents marked as relevant. More...

Xapian::doclength	get_average_length () const
	The average length of a document in the collection. More...

Xapian::doccount	get_termfreq () const
	The number of documents which this term indexes. More...

Xapian::doccount	get_reltermfreq () const
	The number of relevant documents which this term indexes. More...

Xapian::termcount	get_collection_freq () const
	The collection frequency of the term. More...

Xapian::termcount	get_query_length () const
	The length of the query. More...

Xapian::termcount	get_wqf () const
	The within-query-frequency of this term. More...

Xapian::termcount	get_doclength_upper_bound () const
	An upper bound on the maximum length of any document in the database. More...

Xapian::termcount	get_doclength_lower_bound () const
	A lower bound on the minimum length of any document in the database. More...

Xapian::termcount	get_wdf_upper_bound () const
	An upper bound on the wdf of this term. More...

Xapian::totallength	get_total_length () const
	Total length of all documents in the collection. More...

Detailed Description

Definition at line 1899 of file api_db.cc.

Constructor & Destructor Documentation

◆ MyWeight()

MyWeight::MyWeight ( )

inline

Definition at line 1909 of file api_db.cc.

◆ ~MyWeight()

MyWeight::~MyWeight ( )

inline

Definition at line 1910 of file api_db.cc.

Member Function Documentation

◆ clone()

MyWeight* MyWeight::clone ( ) const

inlinevirtual

Clone this object.

This method allocates and returns a copy of the object it is called on.

If your subclass is called FooWeight and has parameters a and b, then you would implement FooWeight::clone() like so:

FooWeight * FooWeight::clone() const { return new FooWeight(a, b); }

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: https://trac.xapian.org/ticket/554#comment:1

Implements Xapian::Weight.

Definition at line 1903 of file api_db.cc.

◆ get_maxextra()

double MyWeight::get_maxextra ( ) const

inlinevirtual

Return an upper bound on what get_sumextra() can return for any document.

This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.

Implements Xapian::Weight.

Definition at line 1920 of file api_db.cc.

◆ get_maxpart()

double MyWeight::get_maxpart ( ) const

inlinevirtual

Return an upper bound on what get_sumpart() can return for any document.

This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.

Implements Xapian::Weight.

Definition at line 1917 of file api_db.cc.

◆ get_sumextra()

double MyWeight::get_sumextra	(	Xapian::termcount	doclen,
		Xapian::termcount	uniqterms
	)		const

inlinevirtual

Calculate the term-independent weight component for a document.

The parameter gives information about the document which may be used in the calculations:

Parameters

doclen	The document's length (unnormalised).
uniqterms	The number of unique terms in the document.

Implements Xapian::Weight.

Definition at line 1919 of file api_db.cc.

◆ get_sumpart()

double MyWeight::get_sumpart	(	Xapian::termcount	wdf,
		Xapian::termcount	doclen,
		Xapian::termcount	uniqterms
	)		const

inlinevirtual

Calculate the weight contribution for this object's term to a document.

The parameters give information about the document which may be used in the calculations:

Parameters

wdf	The within document frequency of the term in the document.
doclen	The document's length (unnormalised).
uniqterms	Number of unique terms in the document (used for absolute smoothing).

Implements Xapian::Weight.

Definition at line 1914 of file api_db.cc.

◆ init()

void MyWeight::init ( double factor )

inlinevirtual

Allow the subclass to perform any initialisation it needs to.

Parameters

factor Any scaling factor (e.g. from OP_SCALE_WEIGHT). If the Weight object is for the term-independent weight supplied by get_sumextra()/get_maxextra(), then init(0.0) is called (starting from Xapian 1.2.11 and 1.3.1 - earlier versions failed to call init() for such Weight objects).

Implements Xapian::Weight.

Definition at line 1906 of file api_db.cc.

◆ name()

std::string MyWeight::name ( ) const

inlinevirtual

Return the name of this weighting scheme.

This name is used by the remote backend. It is passed along with the serialised parameters to the remote server so that it knows which class to create.

Return the full namespace-qualified name of your class here - if your class is called FooWeight, return "FooWeight" from this method (Xapian::BM25Weight returns "Xapian::BM25Weight" here).

If you don't want to support the remote backend, you can use the default implementation which simply returns an empty string.

Reimplemented from Xapian::Weight.

Definition at line 1911 of file api_db.cc.

◆ serialise()

string MyWeight::serialise ( ) const

inlinevirtual

Return this object's parameters serialised as a single string.

If you don't want to support the remote backend, you can use the default implementation which simply throws Xapian::UnimplementedError.

Reimplemented from Xapian::Weight.

Definition at line 1912 of file api_db.cc.

◆ unserialise()

MyWeight* MyWeight::unserialise ( const string & serialised ) const

inlinevirtual

Unserialise parameters.

This method unserialises parameters serialised by the serialise() method and allocates and returns a new object initialised with them.

If you don't want to support the remote backend, you can use the default implementation which simply throws Xapian::UnimplementedError.

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: https://trac.xapian.org/ticket/554#comment:1

Parameters

serialised A string containing the serialised parameters.

Reimplemented from Xapian::Weight.

Definition at line 1913 of file api_db.cc.

Member Data Documentation

◆ scale_factor

double MyWeight::scale_factor

private

Definition at line 1900 of file api_db.cc.

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

tests/api_db.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MyWeight()

◆ ~MyWeight()

Member Function Documentation

◆ clone()

◆ get_maxextra()

◆ get_maxpart()

◆ get_sumextra()

◆ get_sumpart()

◆ init()

◆ name()

◆ serialise()

◆ unserialise()

Member Data Documentation

◆ scale_factor