Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene91

Class Lucene91HnswVectorsReader.OffHeapFloatVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.FloatVectorValues

org.apache.lucene.backward_codecs.lucene91.Lucene91HnswVectorsReader.OffHeapFloatVectorValues

All Implemented Interfaces:

RandomAccessVectorValues<float[]>

Enclosing class:

Lucene91HnswVectorsReader

static class Lucene91HnswVectorsReader.OffHeapFloatVectorValues
extends FloatVectorValues
implements RandomAccessVectorValues<float[]>

Read the vector values from the index input. This supports both iterated and random access.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	byteSize
private final IndexInput	dataIn
private final int	dimension
private int	doc
private int	ord
private final int[]	ordToDoc
private final IntUnaryOperator	ordToDocOperator
private final int	size
private final float[]	value

Fields inherited from class org.apache.lucene.index.FloatVectorValues

MAX_DIMENSIONS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
OffHeapFloatVectorValues(int dimension, int size, int[] ordToDoc, IndexInput dataIn)

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.
RandomAccessVectorValues<float[]>	copy()	Creates a new copy of this RandomAccessVectorValues.
int	dimension()	Return the dimension of the vectors
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
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	size()	Return the number of vectors for this field.
float[]	vectorValue()	Return the vector value for the current document ID.
float[]	vectorValue(int targetOrd)	Return the vector value indexed at the given ordinal.

Methods inherited from class org.apache.lucene.index.FloatVectorValues

cost

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

dimension

private final int dimension

size

private final int size

ordToDoc

private final int[] ordToDoc

ordToDocOperator

private final IntUnaryOperator ordToDocOperator

dataIn

private final IndexInput dataIn

byteSize

private final int byteSize

value

private final float[] value

ord

private int ord

doc

private int doc

Constructor Details

OffHeapFloatVectorValues

OffHeapFloatVectorValues(int dimension,
 int size,
 int[] ordToDoc,
 IndexInput dataIn)

Method Details

dimension

public int dimension()

Description copied from class: FloatVectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues<float[]>

Specified by:

dimension in class FloatVectorValues

size

public int size()

Description copied from class: FloatVectorValues

Return the number of vectors for this field.

Specified by:

size in interface RandomAccessVectorValues<float[]>

Specified by:

size in class FloatVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public float[] vectorValue()
                    throws IOException

Description copied from class: FloatVectorValues

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 FloatVectorValues

Returns:

the vector 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()

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

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 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

copy

public RandomAccessVectorValues<float[]> copy()

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).

Specified by:

copy in interface RandomAccessVectorValues<float[]>

vectorValue

public float[] vectorValue(int targetOrd)
                    throws IOException

Description copied from interface: RandomAccessVectorValues

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues<float[]>

Parameters:

targetOrd - a valid ordinal, ≥ 0 and < RandomAccessVectorValues.size().

Throws:

IOException