Class OffHeapQuantizedByteVectorValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.util.quantization.QuantizedByteVectorValues
org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
- All Implemented Interfaces:
RandomAccessVectorValues
,RandomAccessVectorValues.Bytes
,RandomAccessQuantizedByteVectorValues
- Direct Known Subclasses:
OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues
public abstract class OffHeapQuantizedByteVectorValues
extends QuantizedByteVectorValues
implements RandomAccessQuantizedByteVectorValues
Read the quantized vector values and their score correction values from the index input. This
supports both iterated and random access.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Dense vector values that are stored off-heap.Nested classes/interfaces inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues
RandomAccessVectorValues.Bytes, RandomAccessVectorValues.Floats
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final byte[]
protected final ByteBuffer
protected final int
protected final boolean
protected final int
protected int
protected final int
protected final ScalarQuantizer
protected final float[]
protected final VectorSimilarityFunction
protected final int
protected final IndexInput
protected final FlatVectorsScorer
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Method Summary
Modifier and TypeMethodDescriptionint
Return the dimension of the vectorsfloat
float
getScoreCorrectionConstant
(int targetOrd) getSlice()
Returns a slice of the underlyingIndexInput
that contains the vector values if availableint
Returns the vector byte length, defaults to dimension multiplied by byte sizeload
(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData) int
size()
Return the number of vectors for this field.byte[]
vectorValue
(int targetOrd) Return the vector value indexed at the given ordinal.Methods inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues
cost, scorer, vectorValue
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, docID, empty, nextDoc, range, slowAdvance
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.util.quantization.RandomAccessQuantizedByteVectorValues
copy
Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues
getAcceptOrds, ordToDoc
-
Field Details
-
dimension
protected final int dimension -
size
protected final int size -
numBytes
protected final int numBytes -
scalarQuantizer
-
similarityFunction
-
vectorsScorer
-
compress
protected final boolean compress -
slice
-
binaryValue
protected final byte[] binaryValue -
byteBuffer
-
byteSize
protected final int byteSize -
lastOrd
protected int lastOrd -
scoreCorrectionConstant
protected final float[] scoreCorrectionConstant
-
-
Method Details
-
getScalarQuantizer
- Specified by:
getScalarQuantizer
in interfaceRandomAccessQuantizedByteVectorValues
-
dimension
public int dimension()Description copied from class:QuantizedByteVectorValues
Return the dimension of the vectors- Specified by:
dimension
in interfaceRandomAccessVectorValues
- Specified by:
dimension
in classQuantizedByteVectorValues
-
size
public int size()Description copied from class:QuantizedByteVectorValues
Return the number of vectors for this field.- Specified by:
size
in interfaceRandomAccessVectorValues
- Specified by:
size
in classQuantizedByteVectorValues
- Returns:
- the number of vectors returned by this iterator
-
vectorValue
Description copied from interface:RandomAccessVectorValues.Bytes
Return the vector value indexed at the given ordinal.- Specified by:
vectorValue
in interfaceRandomAccessVectorValues.Bytes
- Parameters:
targetOrd
- a valid ordinal, ≥ 0 and <RandomAccessVectorValues.size()
.- Throws:
IOException
-
getScoreCorrectionConstant
public float getScoreCorrectionConstant()- Specified by:
getScoreCorrectionConstant
in classQuantizedByteVectorValues
-
getScoreCorrectionConstant
- Specified by:
getScoreCorrectionConstant
in interfaceRandomAccessQuantizedByteVectorValues
- Throws:
IOException
-
getSlice
Description copied from interface:RandomAccessVectorValues
Returns a slice of the underlyingIndexInput
that contains the vector values if available- Specified by:
getSlice
in interfaceRandomAccessVectorValues
-
getVectorByteLength
public int getVectorByteLength()Description copied from interface:RandomAccessVectorValues.Bytes
Returns the vector byte length, defaults to dimension multiplied by byte size- Specified by:
getVectorByteLength
in interfaceRandomAccessVectorValues
- Specified by:
getVectorByteLength
in interfaceRandomAccessVectorValues.Bytes
-
load
public static OffHeapQuantizedByteVectorValues load(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData) throws IOException - Throws:
IOException
-