Module org.apache.lucene.core
Class OffHeapByteVectorValues.EmptyOffHeapVectorValues
java.lang.Object
org.apache.lucene.index.KnnVectorValues
org.apache.lucene.index.ByteVectorValues
org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues
org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues.EmptyOffHeapVectorValues
- All Implemented Interfaces:
HasIndexSlice
- Enclosing class:
OffHeapByteVectorValues
private static class OffHeapByteVectorValues.EmptyOffHeapVectorValues
extends OffHeapByteVectorValues
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues
OffHeapByteVectorValues.DenseOffHeapVectorValues
Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues
KnnVectorValues.DocIndexIterator
-
Field Summary
Fields inherited from class org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues
binaryValue, byteBuffer, byteSize, dimension, flatVectorsScorer, lastOrd, similarityFunction, size, slice
-
Constructor Summary
ConstructorsConstructorDescriptionEmptyOffHeapVectorValues
(int dimension, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction) -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a new copy of thisKnnVectorValues
.int
Return the dimension of the vectorsgetAcceptOrds
(Bits acceptDocs) Returns a Bits accepting docs accepted by the argument and having a vector valueiterator()
Create an iterator for this instance.int
ordToDoc
(int ord) Return the docid of the document indexed with the given vector ordinal.scorer
(byte[] query) 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.codecs.lucene95.OffHeapByteVectorValues
getSlice, load
Methods inherited from class org.apache.lucene.index.ByteVectorValues
checkField, fromBytes, getEncoding
Methods inherited from class org.apache.lucene.index.KnnVectorValues
createDenseIterator, createSparseIterator, fromDISI, getVectorByteLength
-
Constructor Details
-
EmptyOffHeapVectorValues
public EmptyOffHeapVectorValues(int dimension, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction)
-
-
Method Details
-
dimension
public int dimension()Description copied from class:KnnVectorValues
Return the dimension of the vectors- Overrides:
dimension
in classOffHeapByteVectorValues
-
size
public int size()Description copied from class:KnnVectorValues
Return the number of vectors for this field.- Overrides:
size
in classOffHeapByteVectorValues
- Returns:
- the number of vectors returned by this iterator
-
vectorValue
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.- Overrides:
vectorValue
in classOffHeapByteVectorValues
- Returns:
- the vector value
- Throws:
IOException
-
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 classByteVectorValues
- 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
-
getAcceptOrds
Description copied from class:KnnVectorValues
Returns a Bits accepting docs accepted by the argument and having a vector value- Overrides:
getAcceptOrds
in classKnnVectorValues
-
scorer
Description copied from class:ByteVectorValues
Return aVectorScorer
for the given query vector.- Overrides:
scorer
in classByteVectorValues
- Parameters:
query
- the query vector- Returns:
- a
VectorScorer
instance or null
-