Package org.apache.lucene.util.hnsw

Interface RandomVectorScorerSupplier

public interface RandomVectorScorerSupplier

A supplier that creates RandomVectorScorer from an ordinal.

Method Summary

Modifier and Type	Method	Description
static RandomVectorScorerSupplier	createBytes(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction)	Creates a RandomVectorScorerSupplier to compare byte vectors.
static RandomVectorScorerSupplier	createFloats(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction)	Creates a RandomVectorScorerSupplier to compare float vectors.
RandomVectorScorer	scorer(int ord)	This creates a RandomVectorScorer for scoring random nodes in batches against the given ordinal.

Method Detail

scorer

RandomVectorScorer scorer(int ord)
                   throws IOException

This creates a RandomVectorScorer for scoring random nodes in batches against the given ordinal.

Parameters:

ord - the ordinal of the node to compare

Returns:

a new RandomVectorScorer

Throws:

IOException

createFloats

static RandomVectorScorerSupplier createFloats(RandomAccessVectorValues<float[]> vectors,
                                               VectorSimilarityFunction similarityFunction)
                                        throws IOException

Creates a RandomVectorScorerSupplier to compare float vectors.

WARNING: The RandomAccessVectorValues given can contain stateful buffers. Avoid using it after calling this function. If you plan to use it again outside the returned RandomVectorScorer, think about passing a copied version (RandomAccessVectorValues.copy()).

Parameters:

vectors - the underlying storage for vectors

similarityFunction - the similarity function to score vectors

Throws:

IOException

createBytes

static RandomVectorScorerSupplier createBytes(RandomAccessVectorValues<byte[]> vectors,
                                              VectorSimilarityFunction similarityFunction)
                                       throws IOException

Creates a RandomVectorScorerSupplier to compare byte vectors.

WARNING: The RandomAccessVectorValues given can contain stateful buffers. Avoid using it after calling this function. If you plan to use it again outside the returned RandomVectorScorer, think about passing a copied version (RandomAccessVectorValues.copy()).

Parameters:

vectors - the underlying storage for vectors

similarityFunction - the similarity function to score vectors

Throws:

IOException