core/org.gnit.lucenekmp.search/ScoreCachingWrappingScorer

ScoreCachingWrappingScorer

class ScoreCachingWrappingScorer(scorer: Scorable) : Scorable

A Scorer which wraps another scorer and caches the score of the current document. Successive calls to .score will return the same result and will not invoke the wrapped Scorer's score() method, unless the current document has changed.

This class might be useful due to the changes done to the Collector interface, in which the score is not computed for a document by default, only if the collector requests it. Some collectors may need to use the score in several places, however all they have in hand is a [ ] object, and might end up computing the score of a document more than once.

Constructors

constructor(scorer: Scorable)

Types

Companion

object Companion

ScoreCachingWrappingLeafCollector

class ScoreCachingWrappingLeafCollector(in: LeafCollector) : FilterLeafCollector

Properties

children

open override val children: MutableCollection<Scorable.ChildScorable>

minCompetitiveScore

open override var minCompetitiveScore: Float

Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the given minScore. This is a no-op by default.

scoreIsCached

var scoreIsCached: Boolean

Functions

score

open override fun score(): Float

Returns the score of the current document matching the query.

smoothingScore

open fun smoothingScore(docId: Int): Float

Returns the smoothing score of the current document matching the query. This score is used when the query/term does not appear in the document, and behaves like an idf. The smoothing score is particularly important when the Scorer returns a product of probabilities so that the document score does not go to zero when one probability is zero. This can return 0 or a smoothing score.