core/org.gnit.lucenekmp.index/KnnVectorValues/DocIndexIterator

DocIndexIterator

abstract class DocIndexIterator : DocIdSetIterator

A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.

Inheritors

SortingValuesIterator

Constructors

DocIndexIterator

constructor()

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:

index

abstract fun index(): Int

return the value index (aka "ordinal" or "ord") corresponding to the current doc

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.