Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class OffHeapQuantizedByteVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.codecs.lucene99.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues

All Implemented Interfaces:

RandomAccessQuantizedByteVectorValues, RandomAccessVectorValues<byte[]>

Direct Known Subclasses:

OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues, OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues, OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues

abstract class OffHeapQuantizedByteVectorValues
extends QuantizedByteVectorValues
implements RandomAccessQuantizedByteVectorValues

Read the quantized vector values and their score correction 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	OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues
private static class	OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues

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 float[]	scoreCorrectionConstant
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
OffHeapQuantizedByteVectorValues(int dimension, int size, IndexInput slice)

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
float	getScoreCorrectionConstant()
(package private) static OffHeapQuantizedByteVectorValues	load(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData)
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

cost, 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.codecs.lucene99.RandomAccessQuantizedByteVectorValues

copy

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

getAcceptOrds, ordToDoc

Field Details

dimension

protected final int dimension

size

protected final int size

slice

protected final IndexInput slice

binaryValue

protected final byte[] binaryValue

byteBuffer

protected final ByteBuffer byteBuffer

byteSize

protected final int byteSize

lastOrd

protected int lastOrd

scoreCorrectionConstant

protected final float[] scoreCorrectionConstant

Constructor Details

OffHeapQuantizedByteVectorValues

OffHeapQuantizedByteVectorValues(int dimension,
 int size,
 IndexInput slice)

Method Details

dimension

public int dimension()

Description copied from class: ByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues<byte[]>

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<byte[]>

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

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues<byte[]>

Parameters:

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

Throws:

IOException

getScoreCorrectionConstant

public float getScoreCorrectionConstant()

Specified by:

getScoreCorrectionConstant in interface RandomAccessQuantizedByteVectorValues

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

load

static OffHeapQuantizedByteVectorValues load(OrdToDocDISIReaderConfiguration configuration,
 int dimension,
 int size,
 long quantizedVectorDataOffset,
 long quantizedVectorDataLength,
 IndexInput vectorData)
                                      throws IOException

Throws:

IOException