Module org.apache.lucene.codecs
Class SimpleTextKnnVectorsReader.SimpleTextByteVectorValues
java.lang.Object
org.apache.lucene.index.KnnVectorValues
org.apache.lucene.index.ByteVectorValues
org.apache.lucene.codecs.simpletext.SimpleTextKnnVectorsReader.SimpleTextByteVectorValues
- Enclosing class:
SimpleTextKnnVectorsReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues
KnnVectorValues.DocIndexIterator
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final BytesRef
(package private) int
private final SimpleTextKnnVectorsReader.FieldEntry
private final IndexInput
private final BytesRefBuilder
private final byte[][]
-
Constructor Summary
ConstructorsModifierConstructorDescription(package private)
private
-
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.private void
private void
readVector
(byte[] value) scorer
(byte[] target) Return aVectorScorer
for the given query vector.int
size()
Return the number of vectors for this field.byte[]
vectorValue
(int ord) 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.ByteVectorValues
checkField, fromBytes, getEncoding
Methods inherited from class org.apache.lucene.index.KnnVectorValues
createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength
-
Field Details
-
scratch
-
entry
-
in
-
binaryValue
-
values
private final byte[][] values -
curOrd
int curOrd
-
-
Constructor Details
-
SimpleTextByteVectorValues
SimpleTextByteVectorValues(SimpleTextKnnVectorsReader.FieldEntry entry, IndexInput in) throws IOException - Throws:
IOException
-
SimpleTextByteVectorValues
-
-
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
-
vectorValue
public byte[] vectorValue(int ord) Description copied from class:ByteVectorValues
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 classByteVectorValues
- Returns:
- the vector value
-
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:ByteVectorValues
Return aVectorScorer
for the given query vector.- Overrides:
scorer
in classByteVectorValues
- Parameters:
target
- the query vector- Returns:
- a
VectorScorer
instance or null
-
readAllVectors
- Throws:
IOException
-
readVector
- Throws:
IOException
-
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 classByteVectorValues
-