Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsReader

java.lang.Object

org.apache.lucene.codecs.hnsw.FlatVectorsReader

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable, QuantizedVectorsReader

public final class Lucene99ScalarQuantizedVectorsReader
extends FlatVectorsReader
implements QuantizedVectorsReader

Reads Scalar Quantized vectors from the index segments along with index data structures.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsReader

vectorScorer

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
Lucene99ScalarQuantizedVectorsReader(SegmentReadState state, FlatVectorsReader rawVectorsReader, FlatVectorsScorer scorer)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
void	close()
ByteVectorValues	getByteVectorValues(String field)	Returns the ByteVectorValues for the given field.
FloatVectorValues	getFloatVectorValues(String field)	Returns the FloatVectorValues for the given field.
ScalarQuantizer	getQuantizationState(String fieldName)
QuantizedByteVectorValues	getQuantizedVectorValues(String fieldName)
RandomVectorScorer	getRandomVectorScorer(String field, byte[] target)	Returns a RandomVectorScorer for the given field and target vector.
RandomVectorScorer	getRandomVectorScorer(String field, float[] target)	Returns a RandomVectorScorer for the given field and target vector.
long	ramBytesUsed()	Return the memory usage of this object in bytes.

Methods inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsReader

getFlatVectorScorer

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

getChildResources

Constructor Detail

Lucene99ScalarQuantizedVectorsReader

public Lucene99ScalarQuantizedVectorsReader(SegmentReadState state,
                                            FlatVectorsReader rawVectorsReader,
                                            FlatVectorsScorer scorer)
                                     throws IOException

Throws:

IOException

Method Detail

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: FlatVectorsReader

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class FlatVectorsReader

Throws:

IOException

getFloatVectorValues

public FloatVectorValues getFloatVectorValues(String field)
                                       throws IOException

Description copied from class: FlatVectorsReader

Returns the FloatVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

Specified by:

getFloatVectorValues in class FlatVectorsReader

Throws:

IOException

getByteVectorValues

public ByteVectorValues getByteVectorValues(String field)
                                     throws IOException

Description copied from class: FlatVectorsReader

Returns the ByteVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

Specified by:

getByteVectorValues in class FlatVectorsReader

Throws:

IOException

getRandomVectorScorer

public RandomVectorScorer getRandomVectorScorer(String field,
                                                float[] target)
                                         throws IOException

Description copied from class: FlatVectorsReader

Returns a RandomVectorScorer for the given field and target vector.

Specified by:

getRandomVectorScorer in class FlatVectorsReader

Parameters:

field - the field to search

target - the target vector

Returns:

a RandomVectorScorer for the given field and target vector.

Throws:

IOException - if an I/O error occurs when reading from the index.

getRandomVectorScorer

public RandomVectorScorer getRandomVectorScorer(String field,
                                                byte[] target)
                                         throws IOException

Description copied from class: FlatVectorsReader

Returns a RandomVectorScorer for the given field and target vector.

Specified by:

getRandomVectorScorer in class FlatVectorsReader

Parameters:

field - the field to search

target - the target vector

Returns:

a RandomVectorScorer for the given field and target vector.

Throws:

IOException - if an I/O error occurs when reading from the index.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getQuantizedVectorValues

public QuantizedByteVectorValues getQuantizedVectorValues(String fieldName)
                                                   throws IOException

Specified by:

getQuantizedVectorValues in interface QuantizedVectorsReader

Throws:

IOException

getQuantizationState

public ScalarQuantizer getQuantizationState(String fieldName)

Specified by:

getQuantizationState in interface QuantizedVectorsReader