Class OffHeapVectorValues.SparseOffHeapVectorValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.VectorValues
org.apache.lucene.codecs.lucene92.OffHeapVectorValues
org.apache.lucene.codecs.lucene92.OffHeapVectorValues.SparseOffHeapVectorValues
- All Implemented Interfaces:
RandomAccessVectorValues
,RandomAccessVectorValuesProducer
- Enclosing class:
- OffHeapVectorValues
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues
OffHeapVectorValues.DenseOffHeapVectorValues
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final IndexInput
private final IndexedDISI
private final Lucene92HnswVectorsReader.FieldEntry
private final DirectMonotonicReader
Fields inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues
binaryValue, byteBuffer, byteSize, dimension, size, slice, value
Fields inherited from class org.apache.lucene.index.VectorValues
EMPTY, MAX_DIMENSIONS
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Constructor Summary
ConstructorsConstructorDescriptionSparseOffHeapVectorValues
(Lucene92HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, 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.Return the binary encoded vector value for the current document ID.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.(package private) Bits
getAcceptOrds
(Bits acceptDocs) 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) Return a random access interface over this iterator's vectors.float[]
Return the vector value for the current document ID.Methods inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues
binaryValue, cost, dimension, load, size, vectorValue
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
ordToDoc
-
disi
-
dataIn
-
fieldEntry
-
-
Constructor Details
-
SparseOffHeapVectorValues
public SparseOffHeapVectorValues(Lucene92HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice) throws IOException - Throws:
IOException
-
-
Method Details
-
vectorValue
Description copied from class:VectorValues
Return the vector value for the current document ID. It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned array may be shared across calls, re-used, and modified as the iterator advances.- Specified by:
vectorValue
in classVectorValues
- Returns:
- the vector value
- Throws:
IOException
-
binaryValue
Description copied from class:VectorValues
Return the binary encoded vector value for the current document ID. These are the bytes corresponding to the float array return byVectorValues.vectorValue()
. It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned storage may be shared across calls, re-used and modified as the iterator advances.- Overrides:
binaryValue
in classVectorValues
- Returns:
- the binary value
- 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
-
randomAccess
Description copied from interface:RandomAccessVectorValuesProducer
Return a random access interface over this iterator's vectors. Calling the RandomAccess methods will have no effect on the progress of the iteration or the values returned by this iterator. Successive calls will retrieve independent copies that do not overwrite each others' returned values.- Throws:
IOException
-
ordToDoc
public int ordToDoc(int ord) - Specified by:
ordToDoc
in classOffHeapVectorValues
-
getAcceptOrds
- Specified by:
getAcceptOrds
in classOffHeapVectorValues
-