Module org.apache.lucene.core
Class Lucene99FlatVectorsReader
java.lang.Object
org.apache.lucene.codecs.FlatVectorsReader
org.apache.lucene.codecs.lucene99.Lucene99FlatVectorsReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Accountable
Reads vectors from the index segments.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Map<String,
Lucene99FlatVectorsReader.FieldEntry> private static final long
private final IndexInput
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
Constructors -
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
.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 int
readMetadata
(SegmentReadState state) private VectorSimilarityFunction
readSimilarityFunction
(DataInput input) private VectorEncoding
readVectorEncoding
(DataInput input) private void
validateFieldEntry
(FieldInfo info, Lucene99FlatVectorsReader.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
-
vectorData
-
-
Constructor Details
-
Lucene99FlatVectorsReader
Lucene99FlatVectorsReader(SegmentReadState state) throws IOException - Throws:
IOException
-
-
Method Details
-
readMetadata
- Throws:
IOException
-
openDataInput
private static IndexInput openDataInput(SegmentReadState state, int versionMeta, String fileExtension, String codecName) throws IOException - Throws:
IOException
-
readFields
- Throws:
IOException
-
validateFieldEntry
-
readSimilarityFunction
- Throws:
IOException
-
readVectorEncoding
- Throws:
IOException
-
readField
- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:Accountable
Return the memory usage of this object in bytes. Negative values are illegal. -
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
-
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
- Throws:
IOException
-