org.apache.lucene.spatial.util

Class ReciprocalDoubleValuesSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.spatial.util.ReciprocalDoubleValuesSource

public class ReciprocalDoubleValuesSource
extends DoubleValuesSource

Transforms a DoubleValuesSource using the formula v = k / (v + k)

Field Summary

Fields inherited from class org.apache.lucene.search.DoubleValuesSource

SCORES

Constructor Summary

Constructors

Constructor and Description
ReciprocalDoubleValuesSource(double distToEdge, DoubleValuesSource input) Creates a ReciprocalDoubleValuesSource

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Explanation	explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.
DoubleValues	getValues(LeafReaderContext ctx, DoubleValues scores) Returns a DoubleValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.
int	hashCode()
boolean	needsScores() Return true if document scores are needed to calculate values
java.lang.String	toString()

Methods inherited from class org.apache.lucene.search.DoubleValuesSource

constant, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromScorer, getSortField, toLongValuesSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReciprocalDoubleValuesSource

public ReciprocalDoubleValuesSource(double distToEdge,
                                    DoubleValuesSource input)

Creates a ReciprocalDoubleValuesSource

Parameters:

distToEdge - the value k in v = k / (v + k)

input - the input DoubleValuesSource to transform

Method Detail

getValues

public DoubleValues getValues(LeafReaderContext ctx,
                              DoubleValues scores)
                       throws java.io.IOException

Description copied from class: DoubleValuesSource

Returns a DoubleValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.

Specified by:

getValues in class DoubleValuesSource

Throws:

java.io.IOException

needsScores

public boolean needsScores()

Description copied from class: DoubleValuesSource

Return true if document scores are needed to calculate values

Specified by:

needsScores in class DoubleValuesSource

explain

public Explanation explain(LeafReaderContext ctx,
                           int docId,
                           Explanation scoreExplanation)
                    throws java.io.IOException

Description copied from class: DoubleValuesSource

An explanation of the value for the named document.

Overrides:

explain in class DoubleValuesSource

Parameters:

ctx - the readers context to create the Explanation for.

docId - the document's id relative to the given context's reader

Returns:

an Explanation for the value

Throws:

java.io.IOException - if an IOException occurs

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource

toString

public java.lang.String toString()

Specified by:

toString in class DoubleValuesSource