core/org.gnit.lucenekmp.index/DocValuesSkipper

DocValuesSkipper

A skipper has a position that can only be advanced via .advance. The next advance position must be greater than .maxDocID at level 0. A skipper's position, along with a level, determines the interval at which the skipper is currently situated.

Constructors

DocValuesSkipper

constructor()

Functions

advance

abstract fun advance(target: Int)

Advance this skipper so that all levels contain the next document on or after target.

fun advance(minValue: Long, maxValue: Long)

Advance this skipper so that all levels intersects the range given by minValue and maxValue. If there are no intersecting levels, the skipper is exhausted.

docCount

abstract fun docCount(): Int

Return the global number of documents with a value for the field.

abstract fun docCount(level: Int): Int

Return the number of documents that have a value in the interval associated with the given level.

maxDocID

abstract fun maxDocID(level: Int): Int

Return the maximum doc ID of the interval on the given level, inclusive. This returns -1 if .advance has not been called yet and DocIdSetIterator.NO_MORE_DOCS if the iterator is exhausted. This method is non-decreasing when level decreases. Said otherwise maxDocID(level+1) >= maxDocId(level).

maxValue

abstract fun maxValue(): Long

Return the global maximum value.

abstract fun maxValue(level: Int): Long

Return the maximum value of the interval at the given level, inclusive.

minDocID

abstract fun minDocID(level: Int): Int

Return the minimum doc ID of the interval on the given level, inclusive. This returns -1 if .advance has not been called yet and DocIdSetIterator.NO_MORE_DOCS if the iterator is exhausted. This method is non-increasing when level increases. Said otherwise minDocID(level+1) <= minDocId(level).

minValue

abstract fun minValue(): Long

Return the global minimum value.

abstract fun minValue(level: Int): Long

Return the minimum value of the interval at the given level, inclusive.

numLevels

abstract fun numLevels(): Int

Return the number of levels. This number may change when moving to a different interval.