Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.util.quantization.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues

All Implemented Interfaces:

HasIndexSlice

Enclosing class:

OffHeapQuantizedByteVectorValues

private static class OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
extends OffHeapQuantizedByteVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues

OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues

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

KnnVectorValues.DocIndexIterator

Field Summary

Fields inherited from class org.apache.lucene.codecs.lucene99.OffHeapQuantizedByteVectorValues

binaryValue, byteBuffer, byteSize, compress, dimension, lastOrd, numBytes, scalarQuantizer, scoreCorrectionConstant, similarityFunction, size, slice, vectorsScorer

Constructor Summary

Constructors

Constructor	Description
EmptyOffHeapVectorValues(int dimension, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer)

Method Summary

Modifier and Type	Method	Description
OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues	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(float[] target)	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.codecs.lucene99.OffHeapQuantizedByteVectorValues

compressBytes, compressedArray, decompressBytes, getScalarQuantizer, getScoreCorrectionConstant, getSlice, getVectorByteLength, load

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

checkField, fromBytes, getEncoding, scorer

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

createDenseIterator, createSparseIterator, fromDISI

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,
 VectorSimilarityFunction similarityFunction,
 FlatVectorsScorer vectorsScorer)

Method Details

dimension

public int dimension()

Description copied from class: KnnVectorValues

Return the dimension of the vectors

Overrides:

dimension in class OffHeapQuantizedByteVectorValues

size

public int size()

Description copied from class: KnnVectorValues

Return the number of vectors for this field.

Overrides:

size in class OffHeapQuantizedByteVectorValues

Returns:

the number of vectors returned by this iterator

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues

copy

public OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues copy()

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.

Overrides:

copy in class QuantizedByteVectorValues

vectorValue

public byte[] vectorValue(int targetOrd)

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 OffHeapQuantizedByteVectorValues

Returns:

the vector value

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

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(float[] target)

Description copied from class: QuantizedByteVectorValues

Return a VectorScorer for the given query vector.

Overrides:

scorer in class QuantizedByteVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null