Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues

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.SparseOffHeapVectorValues

All Implemented Interfaces:

HasIndexSlice

Enclosing class:

OffHeapQuantizedByteVectorValues

private static class OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues
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

Modifier and Type	Field	Description
private final OrdToDocDISIReaderConfiguration	configuration
private final IndexInput	dataIn
private final IndexedDISI	disi
private final DirectMonotonicReader	ordToDoc

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
SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, IndexInput dataIn, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice)

Method Summary

Modifier and Type	Method	Description
OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues	copy()	Creates a new copy of this KnnVectorValues.
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.

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

compressBytes, compressedArray, decompressBytes, dimension, getScalarQuantizer, getScoreCorrectionConstant, getSlice, getVectorByteLength, load, size, vectorValue

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

Field Details

ordToDoc

private final DirectMonotonicReader ordToDoc

disi

private final IndexedDISI disi

dataIn

private final IndexInput dataIn

configuration

private final OrdToDocDISIReaderConfiguration configuration

Constructor Details

SparseOffHeapVectorValues

public SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration,
 int dimension,
 int size,
 ScalarQuantizer scalarQuantizer,
 boolean compress,
 IndexInput dataIn,
 VectorSimilarityFunction similarityFunction,
 FlatVectorsScorer vectorsScorer,
 IndexInput slice)
                          throws IOException

Throws:

IOException

Method Details

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues

copy

public OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues 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.

Overrides:

copy in class QuantizedByteVectorValues

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

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)
                    throws IOException

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

Throws:

IOException