Module org.apache.lucene.core
Class OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.util.quantization.QuantizedByteVectorValues
-
- org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
-
- org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
-
- All Implemented Interfaces:
RandomAccessVectorValues
,RandomAccessVectorValues.Bytes
,RandomAccessQuantizedByteVectorValues
- Enclosing class:
- OffHeapQuantizedByteVectorValues
private static class OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues extends OffHeapQuantizedByteVectorValues
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues
-
Nested classes/interfaces inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues
RandomAccessVectorValues.Bytes, RandomAccessVectorValues.Floats
-
-
Field Summary
Fields Modifier and Type Field Description private int
doc
-
Fields inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
binaryValue, byteBuffer, byteSize, compress, dimension, lastOrd, numBytes, scalarQuantizer, scoreCorrectionConstant, similarityFunction, size, slice, vectorsScorer
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description EmptyOffHeapVectorValues(int dimension, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
advance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
copy()
Creates a new copy of thisRandomAccessVectorValues
.int
dimension()
Return the dimension of the vectorsint
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.Bits
getAcceptOrds(Bits acceptDocs)
Returns theBits
representing live documents.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.int
ordToDoc(int ord)
Translates vector ordinal to the correct document ID.VectorScorer
scorer(float[] target)
Return aVectorScorer
for the given query vector.int
size()
Return the number of vectors for this field.byte[]
vectorValue()
byte[]
vectorValue(int targetOrd)
Return the vector value indexed at the given ordinal.-
Methods inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
compressBytes, compressedArray, decompressBytes, getScalarQuantizer, getScoreCorrectionConstant, getScoreCorrectionConstant, getSlice, getVectorByteLength, load
-
Methods inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues
cost
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Constructor Detail
-
EmptyOffHeapVectorValues
public EmptyOffHeapVectorValues(int dimension, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer)
-
-
Method Detail
-
dimension
public int dimension()
Description copied from class:QuantizedByteVectorValues
Return the dimension of the vectors- Specified by:
dimension
in interfaceRandomAccessVectorValues
- Overrides:
dimension
in classOffHeapQuantizedByteVectorValues
-
size
public int size()
Description copied from class:QuantizedByteVectorValues
Return the number of vectors for this field.- Specified by:
size
in interfaceRandomAccessVectorValues
- Overrides:
size
in classOffHeapQuantizedByteVectorValues
- Returns:
- the number of vectors returned by this iterator
-
vectorValue
public byte[] vectorValue()
- Specified by:
vectorValue
in classQuantizedByteVectorValues
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
nextDoc
public int nextDoc() throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
java.io.IOException
-
advance
public int advance(int target)
Description copied from class:DocIdSetIterator
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.NO_MORE_DOCS
if target is greater than the highest document number in the set.The behavior of this method is undefined when called with
target ≤ current
, or after the iterator has exhausted. Both cases may result in unpredicted behavior.When
target > current
it behaves as if written:int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }
Some implementations are considerably more efficient than that.NOTE: this method may be called with
DocIdSetIterator.NO_MORE_DOCS
for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.- Specified by:
advance
in classDocIdSetIterator
-
copy
public OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues copy()
Description copied from interface:RandomAccessVectorValues
Creates a new copy of thisRandomAccessVectorValues
. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.
-
vectorValue
public byte[] vectorValue(int targetOrd)
Description copied from interface:RandomAccessVectorValues.Bytes
Return the vector value indexed at the given ordinal.- Specified by:
vectorValue
in interfaceRandomAccessVectorValues.Bytes
- Overrides:
vectorValue
in classOffHeapQuantizedByteVectorValues
- Parameters:
targetOrd
- a valid ordinal, ≥ 0 and <RandomAccessVectorValues.size()
.
-
ordToDoc
public int ordToDoc(int ord)
Description copied from interface:RandomAccessVectorValues
Translates vector ordinal to the correct document ID. By default, this is an identity function.- Parameters:
ord
- the vector ordinal- Returns:
- the document Id for that vector ordinal
-
getAcceptOrds
public Bits getAcceptOrds(Bits acceptDocs)
Description copied from interface:RandomAccessVectorValues
Returns theBits
representing live documents. By default, this is an identity function.- Parameters:
acceptDocs
- the accept docs- Returns:
- the accept docs
-
scorer
public VectorScorer scorer(float[] target)
Description copied from class:QuantizedByteVectorValues
Return aVectorScorer
for the given query vector.- Specified by:
scorer
in classQuantizedByteVectorValues
- Parameters:
target
- the query vector- Returns:
- a
VectorScorer
instance or null
-
-