Module org.apache.lucene.core
Package org.apache.lucene.codecs
Class BufferingKnnVectorsWriter.BufferedFloatVectorValues
java.lang.Object
org.apache.lucene.index.KnnVectorValues
org.apache.lucene.index.FloatVectorValues
org.apache.lucene.codecs.BufferingKnnVectorsWriter.BufferedFloatVectorValues
- Enclosing class:
BufferingKnnVectorsWriter
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues
KnnVectorValues.DocIndexIterator
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
private final DocIdSet
private final KnnVectorValues.DocIndexIterator
(package private) final List
<float[]> -
Constructor Summary
ConstructorsConstructorDescriptionBufferedFloatVectorValues
(List<float[]> vectors, int dimension, DocIdSet docsWithField) -
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.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, scorer
Methods inherited from class org.apache.lucene.index.KnnVectorValues
createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength
-
Field Details
-
vectors
-
dimension
final int dimension -
docsWithField
-
iterator
-
-
Constructor Details
-
BufferedFloatVectorValues
BufferedFloatVectorValues(List<float[]> vectors, int dimension, DocIdSet docsWithField) throws IOException - Throws:
IOException
-
-
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
-
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
-
vectorValue
public float[] vectorValue(int targetOrd) 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
-
iterator
Description copied from class:KnnVectorValues
Create an iterator for this instance.- Overrides:
iterator
in classKnnVectorValues
-
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
- Throws:
IOException
-