Module org.apache.lucene.core
Class OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues
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.SparseOffHeapVectorValues
- All Implemented Interfaces:
RandomAccessVectorValues
,RandomAccessVectorValues.Bytes
,RandomAccessQuantizedByteVectorValues
- Enclosing class:
OffHeapQuantizedByteVectorValues
private static class OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues
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
FieldsModifier and TypeFieldDescriptionprivate final OrdToDocDISIReaderConfiguration
private final IndexInput
private final IndexedDISI
private final DirectMonotonicReader
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
ConstructorsConstructorDescriptionSparseOffHeapVectorValues
(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, IndexInput dataIn, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) -
Method Summary
Modifier and TypeMethodDescriptionint
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.copy()
Creates a new copy of thisRandomAccessVectorValues
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.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.scorer
(float[] target) Return aVectorScorer
for the given query vector.byte[]
Methods inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues
compressBytes, compressedArray, decompressBytes, dimension, getScalarQuantizer, getScoreCorrectionConstant, getScoreCorrectionConstant, getSlice, getVectorByteLength, load, size, vectorValue
Methods inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues
cost
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
ordToDoc
-
disi
-
dataIn
-
configuration
-
-
Constructor Details
-
SparseOffHeapVectorValues
public SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, IndexInput dataIn, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) throws IOException - Throws:
IOException
-
-
Method Details
-
vectorValue
- Specified by:
vectorValue
in classQuantizedByteVectorValues
- Throws:
IOException
-
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
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:
IOException
-
advance
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
- Throws:
IOException
-
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.- Throws:
IOException
-
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
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
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 - Throws:
IOException
-