Class DistanceValueSource

An implementation of the Lucene Lucene.Net.Queries.Function.ValueSource model that returns the distance for a PointVectorStrategy.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance
object
ValueSource
DistanceValueSource
Inherited Members
ValueSource.ToString()
ValueSource.NewContext(IndexSearcher)
Namespace: Lucene.Net.Spatial.Vector
Assembly: Lucene.Net.Spatial.dll
Syntax
public class DistanceValueSource : ValueSource

Constructors

DistanceValueSource(PointVectorStrategy, IPoint, double)

Constructor.

Declaration
public DistanceValueSource(PointVectorStrategy strategy, IPoint from, double multiplier)
Parameters
Type Name Description
PointVectorStrategy strategy
IPoint from
double multiplier
Exceptions
Type Condition
ArgumentNullException

strategy or from is null.

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? o)
Parameters
Type Name Description
object o
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetDescription()

Returns the Lucene.Net.Queries.Function.ValueSource description.

Declaration
public override string GetDescription()
Returns
Type Description
string
Overrides
Lucene.Net.Queries.Function.ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
Lucene.Net.Queries.Function.ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Returns the Lucene.Net.Queries.Function.FunctionValues used by the function query.

Declaration
public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)
Parameters
Type Name Description
IDictionary context
AtomicReaderContext readerContext
Returns
Type Description
FunctionValues
Overrides