Package org.apache.lucene.codecs.hnsw

Class ScalarQuantizedVectorScorer

java.lang.Object

org.apache.lucene.codecs.hnsw.ScalarQuantizedVectorScorer

All Implemented Interfaces:

FlatVectorsScorer

public class ScalarQuantizedVectorScorer
extends Object
implements FlatVectorsScorer

Default scalar quantized implementation of FlatVectorsScorer.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScalarQuantizedVectorScorer.ScalarQuantizedRandomVectorScorerSupplier	Quantized vector scorer supplier

Constructor Summary

Constructors

Constructor	Description
ScalarQuantizedVectorScorer(FlatVectorsScorer flatVectorsScorer)

Method Summary

Modifier and Type	Method	Description
RandomVectorScorer	getRandomVectorScorer(VectorSimilarityFunction similarityFunction, RandomAccessVectorValues vectorValues, byte[] target)	Returns a RandomVectorScorer for the given set of vectors and target vector.
RandomVectorScorer	getRandomVectorScorer(VectorSimilarityFunction similarityFunction, RandomAccessVectorValues vectorValues, float[] target)	Returns a RandomVectorScorer for the given set of vectors and target vector.
RandomVectorScorerSupplier	getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, RandomAccessVectorValues vectorValues)	Returns a RandomVectorScorerSupplier that can be used to score vectors
static float	quantizeQuery(float[] query, byte[] quantizedQuery, VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalarQuantizedVectorScorer

public ScalarQuantizedVectorScorer(FlatVectorsScorer flatVectorsScorer)

Method Detail

quantizeQuery

public static float quantizeQuery(float[] query,
                                  byte[] quantizedQuery,
                                  VectorSimilarityFunction similarityFunction,
                                  ScalarQuantizer scalarQuantizer)

getRandomVectorScorerSupplier

public RandomVectorScorerSupplier getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction,
                                                                RandomAccessVectorValues vectorValues)
                                                         throws IOException

Description copied from interface: FlatVectorsScorer

Returns a RandomVectorScorerSupplier that can be used to score vectors

Specified by:

getRandomVectorScorerSupplier in interface FlatVectorsScorer

Parameters:

similarityFunction - the similarity function to use

vectorValues - the vector values to score

Returns:

a RandomVectorScorerSupplier that can be used to score vectors

Throws:

IOException - if an I/O error occurs

getRandomVectorScorer

public RandomVectorScorer getRandomVectorScorer(VectorSimilarityFunction similarityFunction,
                                                RandomAccessVectorValues vectorValues,
                                                float[] target)
                                         throws IOException

Description copied from interface: FlatVectorsScorer

Returns a RandomVectorScorer for the given set of vectors and target vector.

Specified by:

getRandomVectorScorer in interface FlatVectorsScorer

Parameters:

similarityFunction - the similarity function to use

vectorValues - the vector values to score

target - the target vector

Returns:

a RandomVectorScorer for the given field and target vector.

Throws:

IOException - if an I/O error occurs when reading from the index.

getRandomVectorScorer

public RandomVectorScorer getRandomVectorScorer(VectorSimilarityFunction similarityFunction,
                                                RandomAccessVectorValues vectorValues,
                                                byte[] target)
                                         throws IOException

Description copied from interface: FlatVectorsScorer

Returns a RandomVectorScorer for the given set of vectors and target vector.

Specified by:

getRandomVectorScorer in interface FlatVectorsScorer

Parameters:

similarityFunction - the similarity function to use

vectorValues - the vector values to score

target - the target vector

Returns:

a RandomVectorScorer for the given field and target vector.

Throws:

IOException - if an I/O error occurs when reading from the index.

toString

public String toString()

Overrides:

toString in class Object