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
private static class OffHeapVectorValues.SparseOffHeapVectorValues extends OffHeapVectorValues
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues
OffHeapVectorValues.DenseOffHeapVectorValues
-
-
Field Summary
Fields Modifier and Type Field Description private IndexInput
dataIn
private IndexedDISI
disi
private Lucene92HnswVectorsReader.FieldEntry
fieldEntry
private DirectMonotonicReader
ordToDoc
-
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
Constructors Constructor Description SparseOffHeapVectorValues(Lucene92HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice)
-
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.BytesRef
binaryValue()
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)
RandomAccessVectorValues
randomAccess()
Return a random access interface over this iterator's vectors.float[]
vectorValue()
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 Detail
-
ordToDoc
private final DirectMonotonicReader ordToDoc
-
disi
private final IndexedDISI disi
-
dataIn
private final IndexInput dataIn
-
fieldEntry
private final Lucene92HnswVectorsReader.FieldEntry fieldEntry
-
-
Constructor Detail
-
SparseOffHeapVectorValues
public SparseOffHeapVectorValues(Lucene92HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
vectorValue
public float[] vectorValue() throws java.io.IOException
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:
java.io.IOException
-
binaryValue
public BytesRef binaryValue() throws java.io.IOException
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:
java.io.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
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) throws java.io.IOException
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:
java.io.IOException
-
randomAccess
public RandomAccessVectorValues randomAccess() throws java.io.IOException
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:
java.io.IOException
-
ordToDoc
public int ordToDoc(int ord)
- Specified by:
ordToDoc
in classOffHeapVectorValues
-
getAcceptOrds
Bits getAcceptOrds(Bits acceptDocs)
- Specified by:
getAcceptOrds
in classOffHeapVectorValues
-
-