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 Classes Modifier and Type Class Description static classOffHeapQuantizedByteVectorValues.DenseOffHeapVectorValuesDense 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
Fields Modifier and Type Field Description protected byte[]binaryValueprotected ByteBufferbyteBufferprotected intbyteSizeprotected booleancompressprotected intdimensionprotected intlastOrdprotected intnumBytesprotected ScalarQuantizerscalarQuantizerprotected float[]scoreCorrectionConstantprotected VectorSimilarityFunctionsimilarityFunctionprotected intsizeprotected IndexInputsliceprotected FlatVectorsScorervectorsScorer-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intdimension()Return the dimension of the vectorsScalarQuantizergetScalarQuantizer()floatgetScoreCorrectionConstant()floatgetScoreCorrectionConstant(int targetOrd)IndexInputgetSlice()Returns a slice of the underlyingIndexInputthat contains the vector values if availableintgetVectorByteLength()Returns the vector byte length, defaults to dimension multiplied by byte sizestatic OffHeapQuantizedByteVectorValuesload(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData)intsize()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 Detail
-
dimension
protected final int dimension
-
size
protected final int size
-
numBytes
protected final int numBytes
-
scalarQuantizer
protected final ScalarQuantizer scalarQuantizer
-
similarityFunction
protected final VectorSimilarityFunction similarityFunction
-
vectorsScorer
protected final FlatVectorsScorer vectorsScorer
-
compress
protected final boolean compress
-
slice
protected final IndexInput slice
-
binaryValue
protected final byte[] binaryValue
-
byteBuffer
protected final ByteBuffer byteBuffer
-
byteSize
protected final int byteSize
-
lastOrd
protected int lastOrd
-
scoreCorrectionConstant
protected final float[] scoreCorrectionConstant
-
-
Method Detail
-
getScalarQuantizer
public ScalarQuantizer getScalarQuantizer()
- Specified by:
getScalarQuantizerin interfaceRandomAccessQuantizedByteVectorValues
-
dimension
public int dimension()
Description copied from class:QuantizedByteVectorValuesReturn the dimension of the vectors- Specified by:
dimensionin interfaceRandomAccessVectorValues- Specified by:
dimensionin classQuantizedByteVectorValues
-
size
public int size()
Description copied from class:QuantizedByteVectorValuesReturn the number of vectors for this field.- Specified by:
sizein interfaceRandomAccessVectorValues- Specified by:
sizein classQuantizedByteVectorValues- Returns:
- the number of vectors returned by this iterator
-
vectorValue
public byte[] vectorValue(int targetOrd) throws IOExceptionDescription copied from interface:RandomAccessVectorValues.BytesReturn the vector value indexed at the given ordinal.- Specified by:
vectorValuein interfaceRandomAccessVectorValues.Bytes- Parameters:
targetOrd- a valid ordinal, ≥ 0 and <RandomAccessVectorValues.size().- Throws:
IOException
-
getScoreCorrectionConstant
public float getScoreCorrectionConstant()
- Specified by:
getScoreCorrectionConstantin classQuantizedByteVectorValues
-
getScoreCorrectionConstant
public float getScoreCorrectionConstant(int targetOrd) throws IOException- Specified by:
getScoreCorrectionConstantin interfaceRandomAccessQuantizedByteVectorValues- Throws:
IOException
-
getSlice
public IndexInput getSlice()
Description copied from interface:RandomAccessVectorValuesReturns a slice of the underlyingIndexInputthat contains the vector values if available- Specified by:
getSlicein interfaceRandomAccessVectorValues
-
getVectorByteLength
public int getVectorByteLength()
Description copied from interface:RandomAccessVectorValues.BytesReturns the vector byte length, defaults to dimension multiplied by byte size- Specified by:
getVectorByteLengthin interfaceRandomAccessVectorValues- Specified by:
getVectorByteLengthin 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
-
-