core/org.gnit.lucenekmp.search/DocIdSetIterator

DocIdSetIterator

This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore .NO_MORE_DOCS is set to {@value

#NO_MORE_DOCS} in order to be used as a sentinel object. Implementations of this class are expected to consider Integer.MAX_VALUE as an invalid value.

Inheritors

DisjunctionDISIApproximation

Approximation

FilterDocIdSetIterator

FilteredDocIdSetIterator

ImpactsDISI

MinDocIterator

BitSetIterator

DocBaseBitSetIterator

Constructors

DocIdSetIterator

constructor()

Types

Companion

object Companion

Functions

advance

abstract fun advance(target: Int): Int

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns .NO_MORE_DOCS if target is greater than the highest document number in the set.

cost

abstract fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

docID

abstract fun docID(): Int

Returns the following:

intoBitSet

open fun intoBitSet(upTo: Int, bitSet: FixedBitSet, offset: Int)

Load doc IDs into a FixedBitSet. This should behave exactly as if implemented as below, which is the default implementation:

nextDoc

abstract fun nextDoc(): Int

Advances to the next document in the set and returns the doc it is currently on, or .NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.