Class Lucene91HnswVectorsReader.OffHeapFloatVectorValues
java.lang.Object
org.apache.lucene.index.KnnVectorValues
org.apache.lucene.index.FloatVectorValues
org.apache.lucene.backward_codecs.lucene91.Lucene91HnswVectorsReader.OffHeapFloatVectorValues
- Enclosing class:
Lucene91HnswVectorsReader
Read the vector values from the index input. This supports both iterated and random access.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues
KnnVectorValues.DocIndexIterator
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private final IndexInput
private final int
private final int[]
private final IntUnaryOperator
private final VectorSimilarityFunction
private final int
private final float[]
-
Constructor Summary
ConstructorsConstructorDescriptionOffHeapFloatVectorValues
(int dimension, int size, int[] ordToDoc, VectorSimilarityFunction similarityFunction, IndexInput dataIn) -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a new copy of thisKnnVectorValues
.int
Return the dimension of the vectorsiterator()
Create an iterator for this instance.int
ordToDoc
(int ord) Return the docid of the document indexed with the given vector ordinal.scorer
(float[] target) Return aVectorScorer
for the given query vector and the currentFloatVectorValues
.int
size()
Return the number of vectors for this field.float[]
vectorValue
(int targetOrd) 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
-
Field Details
-
dimension
private final int dimension -
size
private final int size -
ordToDoc
private final int[] ordToDoc -
ordToDocOperator
-
dataIn
-
byteSize
private final int byteSize -
value
private final float[] value -
similarityFunction
-
-
Constructor Details
-
OffHeapFloatVectorValues
OffHeapFloatVectorValues(int dimension, int size, int[] ordToDoc, VectorSimilarityFunction similarityFunction, IndexInput dataIn)
-
-
Method Details
-
dimension
public int dimension()Description copied from class:KnnVectorValues
Return the dimension of the vectors- Specified by:
dimension
in classKnnVectorValues
-
size
public int size()Description copied from class:KnnVectorValues
Return the number of vectors for this field.- Specified by:
size
in classKnnVectorValues
- Returns:
- the number of vectors returned by this iterator
-
copy
Description copied from class:KnnVectorValues
Creates a new copy of thisKnnVectorValues
. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.- Specified by:
copy
in classFloatVectorValues
-
vectorValue
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 classFloatVectorValues
- 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 classKnnVectorValues
-
iterator
Description copied from class:KnnVectorValues
Create an iterator for this instance.- Overrides:
iterator
in classKnnVectorValues
-
scorer
Description copied from class:FloatVectorValues
Return aVectorScorer
for the given query vector and the currentFloatVectorValues
.- Overrides:
scorer
in classFloatVectorValues
- Parameters:
target
- the query vector- Returns:
- a
VectorScorer
instance or null
-