Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene90

Class Lucene90HnswVectorsReader.OffHeapFloatVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.FloatVectorValues

org.apache.lucene.backward_codecs.lucene90.Lucene90HnswVectorsReader.OffHeapFloatVectorValues

All Implemented Interfaces:

RandomAccessVectorValues, RandomAccessVectorValues.Floats

Enclosing class:

Lucene90HnswVectorsReader

static class Lucene90HnswVectorsReader.OffHeapFloatVectorValues
extends FloatVectorValues
implements RandomAccessVectorValues.Floats

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

RandomAccessVectorValues.Bytes, RandomAccessVectorValues.Floats

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	byteSize
(package private) final IndexInput	dataIn
(package private) final int	dimension
(package private) int	doc
(package private) int	lastOrd
(package private) int	ord
(package private) final int[]	ordToDoc
(package private) final VectorSimilarityFunction	similarityFunction
(package private) final float[]	value

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
OffHeapFloatVectorValues(int dimension, int[] ordToDoc, VectorSimilarityFunction similarityFunction, 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.
Lucene90HnswVectorsReader.OffHeapFloatVectorValues	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.
VectorScorer	scorer(float[] target)	Return a VectorScorer for the given query vector and the current FloatVectorValues.
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

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

Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

getAcceptOrds, getSlice, ordToDoc

Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues.Floats

getVectorByteLength

Field Details

dimension

final int dimension

ordToDoc

final int[] ordToDoc

dataIn

final IndexInput dataIn

byteSize

final int byteSize

lastOrd

int lastOrd

value

final float[] value

similarityFunction

final VectorSimilarityFunction similarityFunction

ord

int ord

doc

int doc

Constructor Details

OffHeapFloatVectorValues

OffHeapFloatVectorValues(int dimension,
 int[] ordToDoc,
 VectorSimilarityFunction similarityFunction,
 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

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

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 Lucene90HnswVectorsReader.OffHeapFloatVectorValues 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 vector returned.

Specified by:

copy in interface RandomAccessVectorValues

Specified by:

copy in interface RandomAccessVectorValues.Floats

vectorValue

public float[] vectorValue(int targetOrd)
                    throws IOException

Description copied from interface: RandomAccessVectorValues.Floats

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues.Floats

Parameters:

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

Throws:

IOException

scorer

public VectorScorer scorer(float[] target)

Description copied from class: FloatVectorValues

Return a VectorScorer for the given query vector and the current FloatVectorValues. The iterator for the scorer is not the same instance as the iterator for this FloatVectorValues. It is a copy, and iteration over the scorer will not affect the iteration of this FloatVectorValues.

Specified by:

scorer in class FloatVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null