Module org.apache.lucene.core
Class Lucene99ScalarQuantizedVectorsReader
java.lang.Object
org.apache.lucene.codecs.FlatVectorsReader
org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,QuantizedVectorsReader
,Accountable
public final class Lucene99ScalarQuantizedVectorsReader
extends FlatVectorsReader
implements QuantizedVectorsReader
Reads Scalar Quantized vectors from the index segments along with index data structures.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Map<String,
Lucene99ScalarQuantizedVectorsReader.FieldEntry> private final IndexInput
private final FlatVectorsReader
private static final long
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
ConstructorsConstructorDescriptionLucene99ScalarQuantizedVectorsReader
(SegmentReadState state, FlatVectorsReader rawVectorsReader) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Checks consistency of this reader.void
close()
getByteVectorValues
(String field) Returns theByteVectorValues
for the givenfield
.getFloatVectorValues
(String field) Returns theFloatVectorValues
for the givenfield
.getQuantizationState
(String fieldName) getQuantizedVectorValues
(String fieldName) getRandomVectorScorer
(String field, byte[] target) Returns aRandomVectorScorer
for the given field and target vector.getRandomVectorScorer
(String field, float[] target) Returns aRandomVectorScorer
for the given field and target vector.private static IndexInput
openDataInput
(SegmentReadState state, int versionMeta, String fileExtension, String codecName) long
Return the memory usage of this object in bytes.readField
(IndexInput input) private void
readFields
(ChecksumIndexInput meta, FieldInfos infos) private VectorSimilarityFunction
readSimilarityFunction
(DataInput input) private VectorEncoding
readVectorEncoding
(DataInput input) (package private) static void
validateFieldEntry
(FieldInfo info, Lucene99ScalarQuantizedVectorsReader.FieldEntry fieldEntry) 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
-
Field Details
-
SHALLOW_SIZE
private static final long SHALLOW_SIZE -
fields
-
quantizedVectorData
-
rawVectorsReader
-
-
Constructor Details
-
Lucene99ScalarQuantizedVectorsReader
Lucene99ScalarQuantizedVectorsReader(SegmentReadState state, FlatVectorsReader rawVectorsReader) throws IOException - Throws:
IOException
-
-
Method Details
-
readFields
- Throws:
IOException
-
validateFieldEntry
static void validateFieldEntry(FieldInfo info, Lucene99ScalarQuantizedVectorsReader.FieldEntry fieldEntry) -
checkIntegrity
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 classFlatVectorsReader
- Throws:
IOException
-
getFloatVectorValues
Description copied from class:FlatVectorsReader
Returns theFloatVectorValues
for the givenfield
. The behavior is undefined if the given field doesn't have KNN vectors enabled on itsFieldInfo
. The return value is nevernull
.- Specified by:
getFloatVectorValues
in classFlatVectorsReader
- Throws:
IOException
-
getByteVectorValues
Description copied from class:FlatVectorsReader
Returns theByteVectorValues
for the givenfield
. The behavior is undefined if the given field doesn't have KNN vectors enabled on itsFieldInfo
. The return value is nevernull
.- Specified by:
getByteVectorValues
in classFlatVectorsReader
- Throws:
IOException
-
openDataInput
private static IndexInput openDataInput(SegmentReadState state, int versionMeta, String fileExtension, String codecName) throws IOException - Throws:
IOException
-
getRandomVectorScorer
Description copied from class:FlatVectorsReader
Returns aRandomVectorScorer
for the given field and target vector.- Specified by:
getRandomVectorScorer
in classFlatVectorsReader
- Parameters:
field
- the field to searchtarget
- 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
Description copied from class:FlatVectorsReader
Returns aRandomVectorScorer
for the given field and target vector.- Specified by:
getRandomVectorScorer
in classFlatVectorsReader
- Parameters:
field
- the field to searchtarget
- 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
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- 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 interfaceAccountable
-
readField
private Lucene99ScalarQuantizedVectorsReader.FieldEntry readField(IndexInput input) throws IOException - Throws:
IOException
-
readSimilarityFunction
- Throws:
IOException
-
readVectorEncoding
- Throws:
IOException
-
getQuantizedVectorValues
- Specified by:
getQuantizedVectorValues
in interfaceQuantizedVectorsReader
- Throws:
IOException
-
getQuantizationState
- Specified by:
getQuantizationState
in interfaceQuantizedVectorsReader
-