Interface for a weighting function with its state and context used during calculation. More...

Public Member Functions
virtual	~WeightingFunctionContextInterface ()
	Destructor. More...

virtual void	addWeightingFeature (const std::string &name_, PostingIteratorInterface *postingIterator_, double weight_, const TermStatistics &stats_)=0
	Add a feature that is subject of weighting to the execution context. More...

virtual void	setVariableValue (const std::string &name, double value)=0
	Set the value of a query variable. More...

virtual double	call (const Index &docno)=0
	Call the weighting function for a document. More...

virtual std::string	debugCall (const Index &docno)=0
	Get debug info dumped as string of the weighting call for one document. More...

Detailed Description

Interface for a weighting function with its state and context used during calculation.

Constructor & Destructor Documentation

virtual strus::WeightingFunctionContextInterface::~WeightingFunctionContextInterface ( )

inlinevirtual

Destructor.

virtual void strus::WeightingFunctionContextInterface::addWeightingFeature	(	const std::string &	name_,
		PostingIteratorInterface *	postingIterator_,
		double	weight_,
		const TermStatistics &	stats_
	)

pure virtual

Add a feature that is subject of weighting to the execution context.

Parameters

[in]	name_	name of the weighting feature
[in]	postingIterator_	iterator on the matches of the weighting feature (ownership remains at caller)
[in]	weight_	weight of this feature
[in]	stats_	global term statistics passed down with the query. If undefined, they can be defined by or estimated from the posting iterator data.

Remarks: Do call this method before calling call the first time for not having incomplete results

virtual double strus::WeightingFunctionContextInterface::call ( const Index & docno )

pure virtual

Call the weighting function for a document.

Parameters

[in] docno document number

virtual std::string strus::WeightingFunctionContextInterface::debugCall ( const Index & docno )

pure virtual

Get debug info dumped as string of the weighting call for one document.

Parameters

[in] docno document to get the debug info from

virtual void strus::WeightingFunctionContextInterface::setVariableValue	(	const std::string &	name,
		double	value
	)

pure virtual

Set the value of a query variable.

Parameters

[in]	name	name of the variable
[in]	value	value of the variable

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

/home/patrick/Projects/github/strus/include/strus/weightingFunctionContextInterface.hpp