Lucene.Net.Spatial.Util.ReciprocalFloatFunction.FloatDocValues Class Reference

Inherits Lucene.Net.Search.Function.DocValues.

Public Member Functions
	FloatDocValues (ReciprocalFloatFunction enclosingInstance, DocValues vals)
override float	FloatVal (int doc)
	Return doc value as a float. Mandatory: every DocValues implementation must implement at least this method.
override string	ToString (int doc)
	Return a string representation of a doc value, as reuired for Explanations.
Public Member Functions inherited from Lucene.Net.Search.Function.DocValues
virtual int	IntVal (int doc)
	Return doc value as an int. Optional: DocValues implementation can (but don't have to) override this method.
virtual long	LongVal (int doc)
	Return doc value as a long. Optional: DocValues implementation can (but don't have to) override this method.
virtual double	DoubleVal (int doc)
	Return doc value as a double. Optional: DocValues implementation can (but don't have to) override this method.
virtual System.String	StrVal (int doc)
	Return doc value as a string. Optional: DocValues implementation can (but don't have to) override this method.
virtual Explanation	Explain (int doc)
	Explain the scoring value for the input doc.
virtual float	GetMinValue ()
	Returns the minimum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional
virtual float	GetMaxValue ()
	Returns the maximum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional
virtual float	GetAverageValue ()
	Returns the average of all values or Float.NaN if this DocValues instance does not contain any value. * This operation is optional

Detailed Description

Definition at line 46 of file ReciprocalFloatFunction.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Util.ReciprocalFloatFunction.FloatDocValues.FloatDocValues	(	ReciprocalFloatFunction	enclosingInstance,
		DocValues	vals
	)

Definition at line 51 of file ReciprocalFloatFunction.cs.

Member Function Documentation

override float Lucene.Net.Spatial.Util.ReciprocalFloatFunction.FloatDocValues.FloatVal ( int  doc )

virtual

Return doc value as a float. Mandatory: every DocValues implementation must implement at least this method.

Parameters

doc	document whose float value is requested.

Implements Lucene.Net.Search.Function.DocValues.

Definition at line 57 of file ReciprocalFloatFunction.cs.

override string Lucene.Net.Spatial.Util.ReciprocalFloatFunction.FloatDocValues.ToString ( int  doc )

virtual

Return a string representation of a doc value, as reuired for Explanations.

Implements Lucene.Net.Search.Function.DocValues.

Definition at line 62 of file ReciprocalFloatFunction.cs.

---

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

• contrib/Spatial/Util/ReciprocalFloatFunction.cs