core/org.gnit.lucenekmp.codecs.lucene99/Lucene99ScalarQuantizedVectorsReader

Lucene99ScalarQuantizedVectorsReader

class Lucene99ScalarQuantizedVectorsReader(state: SegmentReadState, rawVectorsReader: FlatVectorsReader, scorer: FlatVectorsScorer) : FlatVectorsReader, QuantizedVectorsReader

Reads Scalar Quantized vectors from the index segments along with index data structures.

Constructors

constructor(state: SegmentReadState, rawVectorsReader: FlatVectorsReader, scorer: FlatVectorsScorer)

Types

Companion

object Companion

FieldEntry

class FieldEntry(val similarityFunction: VectorSimilarityFunction, val vectorEncoding: VectorEncoding, val dimension: Int, val vectorDataOffset: Long, val vectorDataLength: Long, val scalarQuantizer: ScalarQuantizer?, val size: Int, val bits: Byte, val compress: Boolean, val ordToDoc: OrdToDocDISIReaderConfiguration)

Properties

childResources

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

mergeInstance

open override val mergeInstance: FlatVectorsReader

Returns an instance optimized for merging. This instance may only be consumed in the thread that called .getMergeInstance.

vectorScorer

open val vectorScorer: FlatVectorsScorer

Scorer for flat vectors

Functions

checkIntegrity

open override fun checkIntegrity()

Checks consistency of this reader.

open override fun close()

finishMerge

open fun finishMerge()

Optional: reset or close merge resources used in the reader

getByteVectorValues

open override fun getByteVectorValues(field: String): ByteVectorValues?

Returns the ByteVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

getFloatVectorValues

open override fun getFloatVectorValues(field: String): FloatVectorValues

Returns the FloatVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

getQuantizationState

open override fun getQuantizationState(fieldName: String): ScalarQuantizer?

getQuantizedVectorValues

open override fun getQuantizedVectorValues(fieldName: String): QuantizedByteVectorValues

getRandomVectorScorer

open override fun getRandomVectorScorer(field: String, target: ByteArray): RandomVectorScorer

open override fun getRandomVectorScorer(field: String, target: FloatArray): RandomVectorScorer

Returns a RandomVectorScorer for the given field and target vector.

ramBytesUsed

open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

open override fun search(field: String, target: ByteArray, knnCollector: KnnCollector, acceptDocs: Bits?)

Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function. The score of each document is derived from the vector similarity in a way that ensures scores are positive and that a larger score corresponds to a higher ranking.

open override fun search(field: String, target: FloatArray, knnCollector: KnnCollector, acceptDocs: Bits?)