core/org.gnit.lucenekmp.search.comparators/MinDocIterator

MinDocIterator

class MinDocIterator : DocIdSetIterator

Docs iterator that starts iterating from a configurable minimum document

Properties

doc

var doc: Int

maxDoc

val maxDoc: Int

segmentMinDoc

val segmentMinDoc: Int

Functions

advance

open override 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

open override fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

docID

open override 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

open override 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.