Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene94

Class OffHeapByteVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

All Implemented Interfaces:

RandomAccessVectorValues<byte[]>

Direct Known Subclasses:

OffHeapByteVectorValues.DenseOffHeapVectorValues, OffHeapByteVectorValues.EmptyOffHeapVectorValues, OffHeapByteVectorValues.SparseOffHeapVectorValues

abstract class OffHeapByteVectorValues
extends ByteVectorValues
implements RandomAccessVectorValues<byte[]>

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

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 int	size
protected final IndexInput	slice

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

MAX_DIMENSIONS

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)

Method Summary

Modifier and Type	Method	Description
int	dimension()	Return the dimension of the vectors
(package private) abstract Bits	getAcceptOrds(Bits acceptDocs)
(package private) static OffHeapByteVectorValues	load(Lucene94HnswVectorsReader.FieldEntry fieldEntry, IndexInput vectorData)
abstract int	ordToDoc(int ord)
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

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.util.hnsw.RandomAccessVectorValues

copy

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

Constructor Details

OffHeapByteVectorValues

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

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

readValue

private void readValue(int targetOrd)
                throws IOException

Throws:

IOException

ordToDoc

public abstract int ordToDoc(int ord)

load

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

Throws:

IOException

getAcceptOrds

abstract Bits getAcceptOrds(Bits acceptDocs)