Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues

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.OffsetCorrectedQuantizedByteVectorValues

All Implemented Interfaces:

HasIndexSlice

Enclosing class:

Lucene99ScalarQuantizedVectorsWriter

static final class Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues
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 final QuantizedByteVectorValues	in
private final ScalarQuantizer	oldScalarQuantizer
private final ScalarQuantizer	scalarQuantizer
private final VectorSimilarityFunction	vectorSimilarityFunction

Constructor Summary

Constructors

Constructor	Description
OffsetCorrectedQuantizedByteVectorValues(QuantizedByteVectorValues in, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer scalarQuantizer, ScalarQuantizer oldScalarQuantizer)

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.
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, scorer

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

in

private final QuantizedByteVectorValues in

vectorSimilarityFunction

private final VectorSimilarityFunction vectorSimilarityFunction

scalarQuantizer

private final ScalarQuantizer scalarQuantizer

oldScalarQuantizer

private final ScalarQuantizer oldScalarQuantizer

Constructor Details

OffsetCorrectedQuantizedByteVectorValues

OffsetCorrectedQuantizedByteVectorValues(QuantizedByteVectorValues in,
 VectorSimilarityFunction vectorSimilarityFunction,
 ScalarQuantizer scalarQuantizer,
 ScalarQuantizer oldScalarQuantizer)

Method Details

getScoreCorrectionConstant

public float getScoreCorrectionConstant(int ord)
                                 throws IOException

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

Throws:

IOException

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

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