Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Search.Payloads.AveragePayloadFunction Class Reference

Calculate the final score as the average score of all payloads seen. Is thread safe and completely reusable. More...

Inherits Lucene.Net.Search.Payloads.PayloadFunction.

Public Member Functions

override 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
 
override 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
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 

Detailed Description

Calculate the final score as the average score of all payloads seen.

Is thread safe and completely reusable.

Definition at line 31 of file AveragePayloadFunction.cs.

Member Function Documentation

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

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

Parameters
docIdThe current doc
fieldThe field
startThe start position of the matching Span
endThe end position of the matching Span
numPayloadsSeenThe number of payloads seen so far
currentScoreThe current score so far
currentPayloadScoreThe score for the current payload
Returns

The new current Score

See Also
Lucene.Net.Search.Spans.Spans

Implements Lucene.Net.Search.Payloads.PayloadFunction.

Definition at line 34 of file AveragePayloadFunction.cs.

override float Lucene.Net.Search.Payloads.AveragePayloadFunction.DocScore ( int  docId,
System.String  field,
int  numPayloadsSeen,
float  payloadScore 
)
virtual

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

Parameters
docIdThe current doc
fieldThe current field
numPayloadsSeenThe total number of payloads seen on this document
payloadScoreThe raw score for those payloads
Returns
The final score for the payloads

Implements Lucene.Net.Search.Payloads.PayloadFunction.

Definition at line 39 of file AveragePayloadFunction.cs.

override bool Lucene.Net.Search.Payloads.AveragePayloadFunction.Equals ( System.Object  obj)
virtual
override int Lucene.Net.Search.Payloads.AveragePayloadFunction.GetHashCode ( )
virtual

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