Uses of Enum Class
org.apache.lucene.index.VectorSimilarityFunction
Packages that use VectorSimilarityFunction
Package
Description
HNSW vector helper classes.
Lucene 10.2 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
The logical representation of a
Document for indexing and
searching.Code to maintain and access indices.
Provides quantization methods for scaling vector values to smaller data types and possibly fewer
dimensions
-
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.hnsw
Methods in org.apache.lucene.codecs.hnsw with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionDefaultFlatVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target) DefaultFlatVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target) FlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target) Returns aRandomVectorScorerfor the given set of vectors and target vector.FlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target) Returns aRandomVectorScorerfor the given set of vectors and target vector.ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target) ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target) DefaultFlatVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues) FlatVectorsScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues) Returns aRandomVectorScorerSupplierthat can be used to score vectorsScalarQuantizedVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues) static floatScalarQuantizedVectorScorer.quantizeQuery(float[] query, byte[] quantizedQuery, VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer) Constructors in org.apache.lucene.codecs.hnsw with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionScalarQuantizedRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, QuantizedByteVectorValues values) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene102
Methods in org.apache.lucene.codecs.lucene102 with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionLucene102BinaryFlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target) Lucene102BinaryFlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target) Lucene102BinaryFlatVectorsScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene95
Fields in org.apache.lucene.codecs.lucene95 declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprotected final VectorSimilarityFunctionOffHeapByteVectorValues.similarityFunctionprotected final VectorSimilarityFunctionOffHeapFloatVectorValues.similarityFunctionMethods in org.apache.lucene.codecs.lucene95 with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic OffHeapByteVectorValuesOffHeapByteVectorValues.load(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) static OffHeapFloatVectorValuesOffHeapFloatVectorValues.load(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) Constructors in org.apache.lucene.codecs.lucene95 with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionDenseOffHeapVectorValues(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction) DenseOffHeapVectorValues(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene99
Fields in org.apache.lucene.codecs.lucene99 declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprotected final VectorSimilarityFunctionOffHeapQuantizedByteVectorValues.similarityFunctionFields in org.apache.lucene.codecs.lucene99 with type parameters of type VectorSimilarityFunctionModifier and TypeFieldDescriptionstatic final List<VectorSimilarityFunction> Lucene99HnswVectorsReader.SIMILARITY_FUNCTIONSMethods in org.apache.lucene.codecs.lucene99 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic VectorSimilarityFunctionLucene99HnswVectorsReader.readSimilarityFunction(DataInput input) Methods in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionLucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target) Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target) Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues) OffHeapQuantizedByteVectorValues.load(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData) Constructors in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionDenseOffHeapVectorValues(int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) -
Uses of VectorSimilarityFunction in org.apache.lucene.document
Methods in org.apache.lucene.document that return VectorSimilarityFunctionMethods in org.apache.lucene.document with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic FieldTypeKnnByteVectorField.createFieldType(int dimension, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.static FieldTypeKnnFloatVectorField.createFieldType(int dimension, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.voidFieldType.setVectorAttributes(int numDimensions, VectorEncoding encoding, VectorSimilarityFunction similarity) Enable vector indexing, with the specified number of dimensions and distance function.Constructors in org.apache.lucene.document with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionKnnByteVectorField(String name, byte[] vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field.KnnFloatVectorField(String name, float[] vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field. -
Uses of VectorSimilarityFunction in org.apache.lucene.index
Methods in org.apache.lucene.index that return VectorSimilarityFunctionModifier and TypeMethodDescriptionFieldInfo.getVectorSimilarityFunction()ReturnsVectorSimilarityFunctionfor the fieldstatic VectorSimilarityFunctionReturns the enum constant of this class with the specified name.static VectorSimilarityFunction[]VectorSimilarityFunction.values()Returns an array containing the constants of this enum class, in the order they are declared.IndexableFieldType.vectorSimilarityFunction()TheVectorSimilarityFunctionof the field's vector valueConstructors in org.apache.lucene.index with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionFieldInfo(String name, int number, boolean storeTermVector, boolean omitNorms, boolean storePayloads, IndexOptions indexOptions, DocValuesType docValues, DocValuesSkipIndexType docValuesSkipIndex, long dvGen, Map<String, String> attributes, int pointDimensionCount, int pointIndexDimensionCount, int pointNumBytes, int vectorDimension, VectorEncoding vectorEncoding, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField, boolean isParentField) Sole constructor. -
Uses of VectorSimilarityFunction in org.apache.lucene.util.quantization
Methods in org.apache.lucene.util.quantization with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic ScalarQuantizerScalarQuantizer.fromVectorsAutoInterval(FloatVectorValues floatVectorValues, VectorSimilarityFunction function, int totalVectorCount, byte bits) ScalarQuantizedVectorSimilarity.fromVectorSimilarity(VectorSimilarityFunction sim, float constMultiplier, byte bits) Creates aScalarQuantizedVectorSimilarityfrom aVectorSimilarityFunctionand the constant multiplier used for quantization.floatScalarQuantizer.quantize(float[] src, byte[] dest, VectorSimilarityFunction similarityFunction) Quantize a float vector into a byte vectorfloatScalarQuantizer.recalculateCorrectiveOffset(byte[] quantizedVector, ScalarQuantizer oldQuantizer, VectorSimilarityFunction similarityFunction) Recalculate the old score corrective value given new current quantilesConstructors in org.apache.lucene.util.quantization with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionOptimizedScalarQuantizer(VectorSimilarityFunction similarityFunction) Create a new scalar quantizer with the default lambda and number of iterations.OptimizedScalarQuantizer(VectorSimilarityFunction similarityFunction, float lambda, int iters) Create a new scalar quantizer with the given similarity function, lambda, and number of iterations.