Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.util.quantization.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues

All Implemented Interfaces:

HasIndexSlice

Enclosing class:

Lucene99ScalarQuantizedVectorsWriter

static class Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues
extends QuantizedByteVectorValues

Nested Class Summary

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

KnnVectorValues.DocIndexIterator

Field Summary

Fields

Modifier and Type	Field	Description
private int	lastOrd
private float	offsetValue
private final byte[]	quantizedVector
private final ScalarQuantizer	quantizer
private final FloatVectorValues	values
private final VectorSimilarityFunction	vectorSimilarityFunction

Constructor Summary

Constructors

Constructor	Description
QuantizedFloatVectorValues(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer)

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
float	getScoreCorrectionConstant(int ord)
KnnVectorValues.DocIndexIterator	iterator()	Create an iterator for this instance.
int	ordToDoc(int ord)	Return the docid of the document indexed with the given vector ordinal.
private float	quantize(int ord)
VectorScorer	scorer(float[] target)	Return a VectorScorer for the given query vector.
int	size()	Return the number of vectors for this field.
byte[]	vectorValue(int ord)	Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown.

Methods inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues

copy, getScalarQuantizer, getSlice

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

checkField, fromBytes, getEncoding, scorer

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

createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength

Methods inherited from class java.lang.Object

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

Field Details

values

private final FloatVectorValues values

quantizer

private final ScalarQuantizer quantizer

quantizedVector

private final byte[] quantizedVector

lastOrd

private int lastOrd

offsetValue

private float offsetValue

vectorSimilarityFunction

private final VectorSimilarityFunction vectorSimilarityFunction

Constructor Details

QuantizedFloatVectorValues

public QuantizedFloatVectorValues(FloatVectorValues values,
 VectorSimilarityFunction vectorSimilarityFunction,
 ScalarQuantizer quantizer)

Method Details

getScoreCorrectionConstant

public float getScoreCorrectionConstant(int ord)

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

dimension

public int dimension()

Description copied from class: KnnVectorValues

Return the dimension of the vectors

Specified by:

dimension in class KnnVectorValues

size

public int size()

Description copied from class: KnnVectorValues

Return the number of vectors for this field.

Specified by:

size in class KnnVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue(int ord)
                   throws IOException

Description copied from class: ByteVectorValues

Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown. The returned array may be shared across calls.

Specified by:

vectorValue in class ByteVectorValues

Returns:

the vector value

Throws:

IOException

scorer

public VectorScorer scorer(float[] target)
                    throws IOException

Description copied from class: QuantizedByteVectorValues

Return a VectorScorer for the given query vector.

Overrides:

scorer in class QuantizedByteVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null

Throws:

IOException

quantize

private float quantize(int ord)
                throws IOException

Throws:

IOException

ordToDoc

public int ordToDoc(int ord)

Description copied from class: KnnVectorValues

Return the docid of the document indexed with the given vector ordinal. This default implementation returns the argument and is appropriate for dense values implementations where every doc has a single value.

Overrides:

ordToDoc in class KnnVectorValues

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues