core/org.gnit.lucenekmp.search/DocValuesRangeIterator

DocValuesRangeIterator

class DocValuesRangeIterator(innerTwoPhase: TwoPhaseIterator, skipper: DocValuesSkipper, lowerValue: Long, upperValue: Long, queryRangeHasGaps: Boolean) : TwoPhaseIterator

Wrapper around a TwoPhaseIterator for a doc-values range query that speeds things up by taking advantage of a DocValuesSkipper.

Constructors

constructor(innerTwoPhase: TwoPhaseIterator, skipper: DocValuesSkipper, lowerValue: Long, upperValue: Long, queryRangeHasGaps: Boolean)

Types

Approximation

abstract class Approximation(innerApproximation: DocIdSetIterator, skipper: DocValuesSkipper, lowerValue: Long, upperValue: Long) : DocIdSetIterator

Match

enum Match : Enum<DocValuesRangeIterator.Match>

Properties

approximation

open val approximation: DocIdSetIterator

Functions

approximation

fun approximation(): DocIdSetIterator

Return an approximation. The returned DocIdSetIterator is a superset of the matching documents, and each match needs to be confirmed with .matches in order to know whether it matches or not.

matchCost

open override fun matchCost(): Float

An estimate of the expected cost to determine that a single document .matches. This can be called before iterating the documents of .approximation. Returns an expected cost in number of simple operations like addition, multiplication, comparing two numbers and indexing an array. The returned value must be positive.

matches

open override fun matches(): Boolean

Return whether the current doc ID that .approximation is on matches. This method should only be called when the iterator is positioned -- ie. not when is -1 or DocIdSetIterator.NO_MORE_DOCS -- and at most once.