Package org.apache.lucene.codecs.lucene99

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 class	OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues	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

Fields

Modifier and Type	Field	Description
protected byte[]	binaryValue
protected ByteBuffer	byteBuffer
protected int	byteSize
protected boolean	compress
protected int	dimension
protected int	lastOrd
protected int	numBytes
protected ScalarQuantizer	scalarQuantizer
protected float[]	scoreCorrectionConstant
protected VectorSimilarityFunction	similarityFunction
protected int	size
protected IndexInput	slice
protected FlatVectorsScorer	vectorsScorer

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
ScalarQuantizer	getScalarQuantizer()
float	getScoreCorrectionConstant()
float	getScoreCorrectionConstant(int targetOrd)
IndexInput	getSlice()	Returns a slice of the underlying IndexInput that contains the vector values if available
int	getVectorByteLength()	Returns the vector byte length, defaults to dimension multiplied by byte size
static OffHeapQuantizedByteVectorValues	load(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 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:

getScalarQuantizer in interface RandomAccessQuantizedByteVectorValues

dimension

public int dimension()

Description copied from class: QuantizedByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues

Specified by:

dimension in class QuantizedByteVectorValues

size

public int size()

Description copied from class: QuantizedByteVectorValues

Return the number of vectors for this field.

Specified by:

size in interface RandomAccessVectorValues

Specified by:

size in class QuantizedByteVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue(int targetOrd)
                   throws IOException

Description copied from interface: RandomAccessVectorValues.Bytes

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues.Bytes

Parameters:

targetOrd - a valid ordinal, ≥ 0 and < RandomAccessVectorValues.size().

Throws:

IOException

getScoreCorrectionConstant

public float getScoreCorrectionConstant()

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

getScoreCorrectionConstant

public float getScoreCorrectionConstant(int targetOrd)
                                 throws IOException

Specified by:

getScoreCorrectionConstant in interface RandomAccessQuantizedByteVectorValues

Throws:

IOException

getSlice

public IndexInput getSlice()

Description copied from interface: RandomAccessVectorValues

Returns a slice of the underlying IndexInput that contains the vector values if available

Specified by:

getSlice in interface RandomAccessVectorValues

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 interface RandomAccessVectorValues

Specified by:

getVectorByteLength in interface RandomAccessVectorValues.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