Package org.apache.lucene.index
Interface RandomAccessVectorValues
-
public interface RandomAccessVectorValues
Provides random access to vectors by dense ordinal.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BytesRef
binaryValue(int targetOrd)
Return the vector indexed at the given ordinal value as an array of bytes in a BytesRef; these are the bytes corresponding to the float array.RandomAccessVectorValues
copy()
Creates a new copy of thisRandomAccessVectorValues
.int
dimension()
Return the dimension of the returned vector valuesint
size()
Return the number of vector valuesfloat[]
vectorValue(int targetOrd)
Return the vector value indexed at the given ordinal.
-
-
-
Method Detail
-
size
int size()
Return the number of vector values
-
dimension
int dimension()
Return the dimension of the returned vector values
-
vectorValue
float[] vectorValue(int targetOrd) throws IOException
Return the vector value indexed at the given ordinal. The provided floating point array may be shared and overwritten by subsequent calls to this method andbinaryValue(int)
.- Parameters:
targetOrd
- a valid ordinal, ≥ 0 and <size()
.- Throws:
IOException
-
binaryValue
BytesRef binaryValue(int targetOrd) throws IOException
Return the vector indexed at the given ordinal value as an array of bytes in a BytesRef; these are the bytes corresponding to the float array. The provided bytes may be shared and overwritten by subsequent calls to this method andvectorValue(int)
.- Parameters:
targetOrd
- a valid ordinal, ≥ 0 and <size()
.- Throws:
IOException
-
copy
RandomAccessVectorValues copy() throws IOException
Creates a new copy of thisRandomAccessVectorValues
. This is helpful when you need to access different values at once, to avoid overwriting the underlying float vector returned byvectorValue(int)
.- Throws:
IOException
-
-