Package org.apache.lucene.codecs.lucene104

Class OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.util.quantization.BaseQuantizedByteVectorValues

org.apache.lucene.util.quantization.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene104.OffHeapScalarQuantizedVectorValues

org.apache.lucene.codecs.lucene104.OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues

All Implemented Interfaces:

HasIndexSlice

Enclosing class:

OffHeapScalarQuantizedVectorValues

public static class OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues
extends OffHeapScalarQuantizedVectorValues

Dense off-heap scalar quantized vector values

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene104.OffHeapScalarQuantizedVectorValues

OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues

Nested classes/interfaces inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues

QuantizedByteVectorValues.ScalarEncoding

Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues

KnnVectorValues.DocIndexIterator

Constructor Summary

Constructors

Constructor	Description
DenseOffHeapVectorValues(boolean isQuerySide, int dimension, int size, float[] centroid, float centroidDp, OptimizedScalarQuantizer quantizer, QuantizedByteVectorValues.ScalarEncoding encoding, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice)	Creates dense off-heap scalar quantized vector values over the given slice.

Method Summary

Modifier and Type	Method	Description
OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues	copy()	Creates a new copy of this KnnVectorValues.
Bits	getAcceptOrds(Bits acceptDocs)	Returns a Bits accepting docs accepted by the argument and having a vector value
KnnVectorValues.DocIndexIterator	iterator()	Create an iterator for this instance.
VectorScorer	scorer(float[] target)	Return a VectorScorer for the given query vector.

Methods inherited from class org.apache.lucene.codecs.lucene104.OffHeapScalarQuantizedVectorValues

dimension, getCentroid, getCentroidDP, getCorrectiveTerms, getQuantizer, getScalarEncoding, getSlice, getVectorByteLength, packNibbles, size, unpackNibbles, vectorValue

Methods inherited from class org.apache.lucene.index.ByteVectorValues

checkField, fromBytes, getEncoding, rescorer, scorer

Methods inherited from class org.apache.lucene.index.KnnVectorValues

createDenseIterator, createSparseIterator, fromDISI, ordToDoc, prefetch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DenseOffHeapVectorValues

public DenseOffHeapVectorValues(boolean isQuerySide,
 int dimension,
 int size,
 float[] centroid,
 float centroidDp,
 OptimizedScalarQuantizer quantizer,
 QuantizedByteVectorValues.ScalarEncoding encoding,
 VectorSimilarityFunction similarityFunction,
 FlatVectorsScorer vectorsScorer,
 IndexInput slice)

Creates dense off-heap scalar quantized vector values over the given slice.

Method Details

copy

public OffHeapScalarQuantizedVectorValues.DenseOffHeapVectorValues copy()
                                                                 throws IOException

Description copied from class: KnnVectorValues

Creates a new copy of this KnnVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.

Specified by:

copy in class QuantizedByteVectorValues

Throws:

IOException

getAcceptOrds

public Bits getAcceptOrds(Bits acceptDocs)

Description copied from class: KnnVectorValues

Returns a Bits accepting docs accepted by the argument and having a vector value

Overrides:

getAcceptOrds in class KnnVectorValues

scorer

public VectorScorer scorer(float[] target)
                    throws IOException

Description copied from class: BaseQuantizedByteVectorValues

Return a VectorScorer for the given query vector.

Overrides:

scorer in class BaseQuantizedByteVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null

Throws:

IOException

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues