An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document. More...

Public Member Functions
abstract float	CurrentScore (int docId, System.String field, int start, int end, int numPayloadsSeen, float currentScore, float currentPayloadScore)
	Calculate the score up to this point for this doc and field

abstract float	DocScore (int docId, System.String field, int numPayloadsSeen, float payloadScore)
	Calculate the final score for all the payloads seen so far for this doc/field

abstract override int	GetHashCode ()

abstract override bool	Equals (System.Object o)

Detailed Description

An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document.

for more information

This class and its derivations are experimental and subject to change

Definition at line 36 of file PayloadFunction.cs.

Member Function Documentation

abstract float Lucene.Net.Search.Payloads.PayloadFunction.CurrentScore	(	int	docId,
		System.String	field,
		int	start,
		int	end,
		int	numPayloadsSeen,
		float	currentScore,
		float	currentPayloadScore
	)

pure virtual

Calculate the score up to this point for this doc and field

Parameters

docId	The current doc
field	The field
start	The start position of the matching Span
end	The end position of the matching Span
numPayloadsSeen	The number of payloads seen so far
currentScore	The current score so far
currentPayloadScore	The score for the current payload

Returns

The new current Score

abstract float Lucene.Net.Search.Payloads.PayloadFunction.DocScore	(	int	docId,
		System.String	field,
		int	numPayloadsSeen,
		float	payloadScore
	)

pure virtual

Calculate the final score for all the payloads seen so far for this doc/field

Parameters

docId	The current doc
field	The current field
numPayloadsSeen	The total number of payloads seen on this document
payloadScore	The raw score for those payloads

abstract override bool Lucene.Net.Search.Payloads.PayloadFunction.Equals ( System.Object o )

pure virtual

abstract override int Lucene.Net.Search.Payloads.PayloadFunction.GetHashCode ( )

pure virtual

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