core/org.gnit.lucenekmp.search/DoubleValuesSource

DoubleValuesSource

abstract class DoubleValuesSource : SegmentCacheable

Base class for producing DoubleValues

To obtain a DoubleValues object for a leaf reader, clients should call .rewrite against the top-level searcher, and then call .getValues on the resulting DoubleValuesSource.

DoubleValuesSource objects for NumericDocValues fields can be obtained by calling .fromDoubleField, .fromFloatField, .fromIntField or .fromLongField, or from .fromField if special long-to-double encoding is required.

Scores may be used as a source for value calculations by wrapping a Scorer using .fromScorer and passing the resulting DoubleValues to .getValues. The scores can then be accessed using the .SCORES DoubleValuesSource.

Constructors

DoubleValuesSource

constructor()

Types

object Companion

Functions

abstract operator override fun equals(obj: Any?): Boolean

open fun explain(ctx: LeafReaderContext, docId: Int, scoreExplanation: Explanation): Explanation

An explanation of the value for the named document.

fun getSortField(reverse: Boolean): SortField

Create a sort field based on the value of this producer

abstract fun getValues(ctx: LeafReaderContext, scores: DoubleValues?): DoubleValues

Returns a DoubleValues instance for the passed-in LeafReaderContext and scores

abstract override fun hashCode(): Int

abstract fun isCacheable(ctx: LeafReaderContext): Boolean

abstract fun needsScores(): Boolean

Return true if document scores are needed to calculate values

abstract fun rewrite(reader: IndexSearcher): DoubleValuesSource

Return a DoubleValuesSource specialised for the given IndexSearcher

toLongValuesSource

fun toLongValuesSource(): LongValuesSource

Convert to a LongValuesSource by casting the double values to longs

toSortableLongDoubleValuesSource

fun toSortableLongDoubleValuesSource(): LongValuesSource

Convert to LongValuesSource by calling NumericUtils.doubleToSortableLong

abstract override fun toString(): String