Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene94

Class OffHeapByteVectorValues.EmptyOffHeapVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues.EmptyOffHeapVectorValues

Enclosing class:

OffHeapByteVectorValues

private static class OffHeapByteVectorValues.EmptyOffHeapVectorValues
extends OffHeapByteVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

OffHeapByteVectorValues.DenseOffHeapVectorValues

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

KnnVectorValues.DocIndexIterator

Field Summary

Fields inherited from class org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

binaryValue, byteBuffer, byteSize, dimension, lastOrd, size, slice, vectorSimilarityFunction

Constructor Summary

Constructors

Constructor	Description
EmptyOffHeapVectorValues(int dimension)

Method Summary

Modifier and Type	Method	Description
OffHeapByteVectorValues	copy()	Creates a new copy of this KnnVectorValues.
int	dimension()	Return the dimension of the vectors
Bits	getAcceptOrds(Bits acceptDocs)	Returns a Bits accepting docs accepted by the argument and having a vector value
KnnVectorValues.DocIndexIterator	iterator()	Create an iterator for this instance.
int	ordToDoc(int ord)	Return the docid of the document indexed with the given vector ordinal.
VectorScorer	scorer(byte[] query)	Return a VectorScorer for the given query vector.
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.backward_codecs.lucene94.OffHeapByteVectorValues

load

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

checkField, fromBytes, getEncoding

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

createDenseIterator, createSparseIterator, fromDISI, getVectorByteLength

Methods inherited from class java.lang.Object

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

Constructor Details

EmptyOffHeapVectorValues

public EmptyOffHeapVectorValues(int dimension)

Method Details

dimension

public int dimension()

Description copied from class: KnnVectorValues

Return the dimension of the vectors

Overrides:

dimension in class OffHeapByteVectorValues

size

public int size()

Description copied from class: KnnVectorValues

Return the number of vectors for this field.

Overrides:

size in class OffHeapByteVectorValues

Returns:

the number of vectors returned by this iterator

copy

public OffHeapByteVectorValues copy()
                             throws IOException

Description copied from class: KnnVectorValues

Creates a new copy of this KnnVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.

Specified by:

copy in class ByteVectorValues

Throws:

IOException

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.

Overrides:

vectorValue in class OffHeapByteVectorValues

Returns:

the vector value

Throws:

IOException

ordToDoc

public int ordToDoc(int ord)

Description copied from class: KnnVectorValues

Return the docid of the document indexed with the given vector ordinal. This default implementation returns the argument and is appropriate for dense values implementations where every doc has a single value.

Overrides:

ordToDoc in class KnnVectorValues

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues

getAcceptOrds

public Bits getAcceptOrds(Bits acceptDocs)

Description copied from class: KnnVectorValues

Returns a Bits accepting docs accepted by the argument and having a vector value

Overrides:

getAcceptOrds in class KnnVectorValues

scorer

public VectorScorer scorer(byte[] query)

Description copied from class: ByteVectorValues

Return a VectorScorer for the given query vector.

Overrides:

scorer in class ByteVectorValues

Parameters:

query - the query vector

Returns:

a VectorScorer instance or null