Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene95

Class OffHeapByteVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues

All Implemented Interfaces:

RandomAccessVectorValues, RandomAccessVectorValues.Bytes

Direct Known Subclasses:

OffHeapByteVectorValues.DenseOffHeapVectorValues, OffHeapByteVectorValues.EmptyOffHeapVectorValues, OffHeapByteVectorValues.SparseOffHeapVectorValues

public abstract class OffHeapByteVectorValues
extends ByteVectorValues
implements RandomAccessVectorValues.Bytes

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
static class	OffHeapByteVectorValues.DenseOffHeapVectorValues	Dense vector values that are stored off-heap.
private static class	OffHeapByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapByteVectorValues.SparseOffHeapVectorValues

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

RandomAccessVectorValues.Bytes, RandomAccessVectorValues.Floats

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 final FlatVectorsScorer	flatVectorsScorer
protected int	lastOrd
protected final VectorSimilarityFunction	similarityFunction
protected final int	size
protected final IndexInput	slice

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
OffHeapByteVectorValues(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction)

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
IndexInput	getSlice()	Returns a slice of the underlying IndexInput that contains the vector values if available
static OffHeapByteVectorValues	load(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, 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 indexed at the given ordinal.

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

checkField, cost, scorer, vectorValue

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

advance, all, docID, empty, nextDoc, 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, ordToDoc

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

copy, getVectorByteLength

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

similarityFunction

protected final VectorSimilarityFunction similarityFunction

flatVectorsScorer

protected final FlatVectorsScorer flatVectorsScorer

Constructor Details

OffHeapByteVectorValues

OffHeapByteVectorValues(int dimension,
 int size,
 IndexInput slice,
 int byteSize,
 FlatVectorsScorer flatVectorsScorer,
 VectorSimilarityFunction similarityFunction)

Method Details

dimension

public int dimension()

Description copied from class: ByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues

Specified by:

dimension in class ByteVectorValues

size

public int size()

Description copied from class: ByteVectorValues

Return the number of vectors for this field.

Specified by:

size in interface RandomAccessVectorValues

Specified by:

size in class ByteVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue(int targetOrd)
                   throws IOException

Description copied from interface: RandomAccessVectorValues.Bytes

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues.Bytes

Parameters:

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

Throws:

IOException

getSlice

public IndexInput getSlice()

Description copied from interface: RandomAccessVectorValues

Returns a slice of the underlying IndexInput that contains the vector values if available

Specified by:

getSlice in interface RandomAccessVectorValues

readValue

private void readValue(int targetOrd)
                throws IOException

Throws:

IOException

load

public static OffHeapByteVectorValues load(VectorSimilarityFunction vectorSimilarityFunction,
 FlatVectorsScorer flatVectorsScorer,
 OrdToDocDISIReaderConfiguration configuration,
 VectorEncoding vectorEncoding,
 int dimension,
 long vectorDataOffset,
 long vectorDataLength,
 IndexInput vectorData)
                                    throws IOException

Throws:

IOException