Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene94

Class OffHeapByteVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

Direct Known Subclasses:

OffHeapByteVectorValues.DenseOffHeapVectorValues, OffHeapByteVectorValues.EmptyOffHeapVectorValues, OffHeapByteVectorValues.SparseOffHeapVectorValues

abstract class OffHeapByteVectorValues
extends ByteVectorValues

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	OffHeapByteVectorValues.DenseOffHeapVectorValues
private static class	OffHeapByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapByteVectorValues.SparseOffHeapVectorValues

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

KnnVectorValues.DocIndexIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected final byte[]	binaryValue
protected final ByteBuffer	byteBuffer
protected final int	byteSize
protected final int	dimension
protected int	lastOrd
protected final int	size
protected final IndexInput	slice
protected final VectorSimilarityFunction	vectorSimilarityFunction

Constructor Summary

Constructors

Constructor	Description
OffHeapByteVectorValues(int dimension, int size, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
(package private) static OffHeapByteVectorValues	load(Lucene94HnswVectorsReader.FieldEntry fieldEntry, IndexInput vectorData)
private void	readValue(int targetOrd)
int	size()	Return the number of vectors for this field.
byte[]	vectorValue(int targetOrd)	Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown.

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

checkField, copy, fromBytes, getEncoding, scorer

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

createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength, iterator, ordToDoc

Methods inherited from class java.lang.Object

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

Field Details

dimension

protected final int dimension

size

protected final int size

slice

protected final IndexInput slice

lastOrd

protected int lastOrd

binaryValue

protected final byte[] binaryValue

byteBuffer

protected final ByteBuffer byteBuffer

byteSize

protected final int byteSize

vectorSimilarityFunction

protected final VectorSimilarityFunction vectorSimilarityFunction

Constructor Details

OffHeapByteVectorValues

OffHeapByteVectorValues(int dimension,
 int size,
 IndexInput slice,
 VectorSimilarityFunction vectorSimilarityFunction,
 int byteSize)

Method Details

dimension

public int dimension()

Description copied from class: KnnVectorValues

Return the dimension of the vectors

Specified by:

dimension in class KnnVectorValues

size

public int size()

Description copied from class: KnnVectorValues

Return the number of vectors for this field.

Specified by:

size in class KnnVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue(int targetOrd)
                   throws IOException

Description copied from class: ByteVectorValues

Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown. The returned array may be shared across calls.

Specified by:

vectorValue in class ByteVectorValues

Returns:

the vector value

Throws:

IOException

readValue

private void readValue(int targetOrd)
                throws IOException

Throws:

IOException

load

static OffHeapByteVectorValues load(Lucene94HnswVectorsReader.FieldEntry fieldEntry,
 IndexInput vectorData)
                             throws IOException

Throws:

IOException