Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.FloatVectorValues

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues

Enclosing class:

Lucene99ScalarQuantizedVectorsReader

private static final class Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues
extends FloatVectorValues

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 final QuantizedByteVectorValues	quantizedVectorValues
private final FloatVectorValues	rawVectorValues

Constructor Summary

Constructors

Constructor	Description
QuantizedVectorValues(FloatVectorValues rawVectorValues, QuantizedByteVectorValues quantizedVectorValues)

Method Summary

Modifier and Type	Method	Description
Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues	copy()	Creates a new copy of this KnnVectorValues.
int	dimension()	Return the dimension of the vectors
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.
VectorScorer	scorer(float[] query)	Return a VectorScorer for the given query vector and the current FloatVectorValues.
int	size()	Return the number of vectors for this field.
float[]	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.index.FloatVectorValues

checkField, fromFloats, getEncoding

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

rawVectorValues

private final FloatVectorValues rawVectorValues

quantizedVectorValues

private final QuantizedByteVectorValues quantizedVectorValues

Constructor Details

QuantizedVectorValues

QuantizedVectorValues(FloatVectorValues rawVectorValues,
 QuantizedByteVectorValues quantizedVectorValues)

Method Details

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 float[] vectorValue(int ord)
                    throws IOException

Description copied from class: FloatVectorValues

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 FloatVectorValues

Returns:

the vector value

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

copy

public Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues 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 FloatVectorValues

Throws:

IOException

scorer

public VectorScorer scorer(float[] query)
                    throws IOException

Description copied from class: FloatVectorValues

Return a VectorScorer for the given query vector and the current FloatVectorValues.

Overrides:

scorer in class FloatVectorValues

Parameters:

query - 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