Package org.apache.lucene.codecs.lucene94

Class OffHeapVectorValues.SparseOffHeapVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.VectorValues

org.apache.lucene.codecs.lucene94.OffHeapVectorValues

org.apache.lucene.codecs.lucene94.OffHeapVectorValues.SparseOffHeapVectorValues

All Implemented Interfaces:

RandomAccessVectorValues

Enclosing class:

OffHeapVectorValues

private static class OffHeapVectorValues.SparseOffHeapVectorValues
extends OffHeapVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene94.OffHeapVectorValues

OffHeapVectorValues.DenseOffHeapVectorValues

Nested classes/interfaces inherited from class org.apache.lucene.index.VectorValues

VectorValues.SortingVectorValues

Field Summary

Fields

Modifier and Type	Field	Description
private final IndexInput	dataIn
private final IndexedDISI	disi
private final Lucene94HnswVectorsReader.FieldEntry	fieldEntry
private final DirectMonotonicReader	ordToDoc

Fields inherited from class org.apache.lucene.codecs.lucene94.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(Lucene94HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice, int byteSize)

Method Summary

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.
RandomAccessVectorValues	copy()	Creates a new copy of this RandomAccessVectorValues.
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.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, or DocIdSetIterator.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)
float[]	vectorValue()	Return the vector value for the current document ID.

Methods inherited from class org.apache.lucene.codecs.lucene94.OffHeapVectorValues

binaryValue, cost, dimension, load, size, vectorValue

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ordToDoc

private final DirectMonotonicReader ordToDoc

disi

private final IndexedDISI disi

dataIn

private final IndexInput dataIn

fieldEntry

private final Lucene94HnswVectorsReader.FieldEntry fieldEntry

Constructor Details

SparseOffHeapVectorValues

public SparseOffHeapVectorValues(Lucene94HnswVectorsReader.FieldEntry fieldEntry,
 IndexInput dataIn,
 IndexInput slice,
 int byteSize)
                          throws IOException

Throws:

IOException

Method Details

vectorValue

public float[] vectorValue()
                    throws 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 class VectorValues

Returns:

the vector value

Throws:

IOException

binaryValue

public BytesRef binaryValue()
                     throws 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 by VectorValues.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 class VectorValues

Returns:

the binary value

Throws:

IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.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 class DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.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 class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws 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 returns DocIdSetIterator.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 class DocIdSetIterator

Throws:

IOException

copy

public RandomAccessVectorValues copy()
                              throws IOException

Description copied from interface: RandomAccessVectorValues

Creates a new copy of this RandomAccessVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying float vector returned by RandomAccessVectorValues.vectorValue(int).

Throws:

IOException

ordToDoc

public int ordToDoc(int ord)

Specified by:

ordToDoc in class OffHeapVectorValues

getAcceptOrds

Bits getAcceptOrds(Bits acceptDocs)

Specified by:

getAcceptOrds in class OffHeapVectorValues