Uses of Enum Class
org.apache.lucene.index.VectorSimilarityFunction

Packages that use VectorSimilarityFunction

Package	Description
org.apache.lucene.analysis.synonym.word2vec	Analysis components for Synonyms using Word2Vec model.
org.apache.lucene.backward_codecs.lucene90	Lucene 9.0 file format.
org.apache.lucene.backward_codecs.lucene91	Lucene 9.1 file format.
org.apache.lucene.backward_codecs.lucene92	Lucene 9.2 file format.
org.apache.lucene.backward_codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.backward_codecs.lucene95	Lucene 9.5 file format.
org.apache.lucene.codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.codecs.lucene99	Lucene 9.9 file format.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.queries.function.valuesource	A variety of functions to use with FunctionQuery.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.util	Some utility classes.
org.apache.lucene.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.

Uses of VectorSimilarityFunction in org.apache.lucene.analysis.synonym.word2vec

Fields in org.apache.lucene.analysis.synonym.word2vec declared as VectorSimilarityFunction

Modifier and Type	Field	Description
private static final VectorSimilarityFunction	Word2VecSynonymProvider.SIMILARITY_FUNCTION

Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene90

Fields in org.apache.lucene.backward_codecs.lucene90 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
private final VectorSimilarityFunction	Lucene90HnswGraphBuilder.similarityFunction
(package private) final VectorSimilarityFunction	Lucene90HnswVectorsReader.FieldEntry.similarityFunction

Methods in org.apache.lucene.backward_codecs.lucene90 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private static VectorSimilarityFunction	Lucene90FieldInfosFormat.getDistFunc(IndexInput input, byte b)
private VectorSimilarityFunction	Lucene90HnswVectorsReader.readSimilarityFunction(DataInput input)

Methods in org.apache.lucene.backward_codecs.lucene90 with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
static NeighborQueue	Lucene90OnHeapHnswGraph.search(float[] query, int topK, int numSeed, RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction, HnswGraph graphValues, Bits acceptOrds, long visitedLimit, SplittableRandom random)	Searches for the nearest neighbors of a query vector.

Constructors in org.apache.lucene.backward_codecs.lucene90 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(DataInput input, VectorSimilarityFunction similarityFunction)
	Lucene90HnswGraphBuilder(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction, int maxConn, int beamWidth, long seed)	Reads all the vectors from vector values, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.

Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene91

Fields in org.apache.lucene.backward_codecs.lucene91 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	Lucene91HnswVectorsReader.FieldEntry.similarityFunction

Methods in org.apache.lucene.backward_codecs.lucene91 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene91HnswVectorsReader.readSimilarityFunction(DataInput input)

Constructors in org.apache.lucene.backward_codecs.lucene91 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(DataInput input, VectorSimilarityFunction similarityFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene92

Fields in org.apache.lucene.backward_codecs.lucene92 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	Lucene92HnswVectorsReader.FieldEntry.similarityFunction

Methods in org.apache.lucene.backward_codecs.lucene92 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene92HnswVectorsReader.readSimilarityFunction(DataInput input)

Constructors in org.apache.lucene.backward_codecs.lucene92 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorSimilarityFunction similarityFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene94

Fields in org.apache.lucene.backward_codecs.lucene94 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	Lucene94HnswVectorsReader.FieldEntry.similarityFunction

Methods in org.apache.lucene.backward_codecs.lucene94 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene94HnswVectorsReader.readSimilarityFunction(DataInput input)

Constructors in org.apache.lucene.backward_codecs.lucene94 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene95

Fields in org.apache.lucene.backward_codecs.lucene95 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	Lucene95HnswVectorsReader.FieldEntry.similarityFunction

Methods in org.apache.lucene.backward_codecs.lucene95 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene95HnswVectorsReader.readSimilarityFunction(DataInput input)

Constructors in org.apache.lucene.backward_codecs.lucene95 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene94

Methods in org.apache.lucene.codecs.lucene94 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private static VectorSimilarityFunction	Lucene94FieldInfosFormat.getDistFunc(IndexInput input, byte b)

Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene99

Fields in org.apache.lucene.codecs.lucene99 declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	Lucene99FlatVectorsReader.FieldEntry.similarityFunction
(package private) final VectorSimilarityFunction	Lucene99HnswVectorsReader.FieldEntry.similarityFunction
(package private) final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsReader.FieldEntry.similarityFunction
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues.vectorSimilarityFunction
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues.vectorSimilarityFunction

Methods in org.apache.lucene.codecs.lucene99 that return VectorSimilarityFunction

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene99FlatVectorsReader.readSimilarityFunction(DataInput input)
private VectorSimilarityFunction	Lucene99HnswVectorsReader.readSimilarityFunction(DataInput input)
private VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsReader.readSimilarityFunction(DataInput input)

Methods in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
private static float	ScalarQuantizedRandomVectorScorer.quantizeQuery(float[] query, byte[] quantizedQuery, VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer)

Constructors in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
private	OffsetCorrectedQuantizedByteVectorValues(QuantizedByteVectorValues in, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer scalarQuantizer, ScalarQuantizer oldScalarQuantizer)
	QuantizedFloatVectorValues(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer)
(package private)	ScalarQuantizedRandomVectorScorer(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, RandomAccessQuantizedByteVectorValues values, float[] query)
(package private)	ScalarQuantizedRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, RandomAccessQuantizedByteVectorValues values)

Uses of VectorSimilarityFunction in org.apache.lucene.codecs.simpletext

Methods in org.apache.lucene.codecs.simpletext that return VectorSimilarityFunction

Modifier and Type	Method	Description
VectorSimilarityFunction	SimpleTextFieldInfosFormat.distanceFunction(String scoreFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.document

Fields in org.apache.lucene.document declared as VectorSimilarityFunction

Modifier and Type	Field	Description
private VectorSimilarityFunction	FieldType.vectorSimilarityFunction

Methods in org.apache.lucene.document that return VectorSimilarityFunction

Modifier and Type	Method	Description
VectorSimilarityFunction	FieldType.vectorSimilarityFunction()

Methods in org.apache.lucene.document with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
static FieldType	KnnByteVectorField.createFieldType(int dimension, VectorSimilarityFunction similarityFunction)	A convenience method for creating a vector field type.
static FieldType	KnnFloatVectorField.createFieldType(int dimension, VectorSimilarityFunction similarityFunction)	A convenience method for creating a vector field type.
private static FieldType	KnnByteVectorField.createType(byte[] v, VectorSimilarityFunction similarityFunction)
private static FieldType	KnnFloatVectorField.createType(float[] v, VectorSimilarityFunction similarityFunction)
void	FieldType.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 VectorSimilarityFunction

Modifier	Constructor	Description
	KnnByteVectorField(String name, byte[] vector, VectorSimilarityFunction similarityFunction)	Creates a numeric vector field.
	KnnFloatVectorField(String name, float[] vector, VectorSimilarityFunction similarityFunction)	Creates a numeric vector field.
	KnnVectorField(String name, float[] vector, VectorSimilarityFunction similarityFunction)	Deprecated. Creates a numeric vector field.

Uses of VectorSimilarityFunction in org.apache.lucene.index

Fields in org.apache.lucene.index declared as VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) final VectorSimilarityFunction	FieldInfos.FieldVectorProperties.similarityFunction
private final VectorSimilarityFunction	FieldInfo.vectorSimilarityFunction
private VectorSimilarityFunction	IndexingChain.FieldSchema.vectorSimilarityFunction

Methods in org.apache.lucene.index that return VectorSimilarityFunction

Modifier and Type	Method	Description
VectorSimilarityFunction	FieldInfo.getVectorSimilarityFunction()	Returns VectorSimilarityFunction for the field
static VectorSimilarityFunction	VectorSimilarityFunction.valueOf(String name)	Returns 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.
VectorSimilarityFunction	IndexableFieldType.vectorSimilarityFunction()	The VectorSimilarityFunction of the field's vector value

Methods in org.apache.lucene.index with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
(package private) void	IndexingChain.FieldSchema.setVectors(VectorEncoding encoding, VectorSimilarityFunction similarityFunction, int dimension)
(package private) static void	FieldInfo.verifySameVectorOptions(String fieldName, int vd1, VectorEncoding ve1, VectorSimilarityFunction vsf1, int vd2, VectorEncoding ve2, VectorSimilarityFunction vsf2)	Verify that the provided vector indexing options are the same

Constructors in org.apache.lucene.index with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
	FieldInfo(String name, int number, boolean storeTermVector, boolean omitNorms, boolean storePayloads, IndexOptions indexOptions, DocValuesType docValues, long dvGen, Map<String,String> attributes, int pointDimensionCount, int pointIndexDimensionCount, int pointNumBytes, int vectorDimension, VectorEncoding vectorEncoding, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField)	Sole constructor.
(package private)	FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

Uses of VectorSimilarityFunction in org.apache.lucene.queries.function.valuesource

Fields in org.apache.lucene.queries.function.valuesource declared as VectorSimilarityFunction

Modifier and Type	Field	Description
protected final VectorSimilarityFunction	VectorSimilarityFunction.similarityFunction

Constructors in org.apache.lucene.queries.function.valuesource with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
	ByteVectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)
	FloatVectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)
	VectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)

Uses of VectorSimilarityFunction in org.apache.lucene.search

Fields in org.apache.lucene.search declared as VectorSimilarityFunction

Modifier and Type	Field	Description
protected final VectorSimilarityFunction	VectorScorer.similarity

Constructors in org.apache.lucene.search with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
protected	ByteVectorScorer(ByteVectorValues values, byte[] query, VectorSimilarityFunction similarity)
protected	FloatVectorScorer(FloatVectorValues values, float[] query, VectorSimilarityFunction similarity)
(package private)	VectorScorer(VectorSimilarityFunction similarity)

Uses of VectorSimilarityFunction in org.apache.lucene.search.join

Fields in org.apache.lucene.search.join declared as VectorSimilarityFunction

Modifier and Type	Field	Description
private final VectorSimilarityFunction	DiversifyingChildrenByteKnnVectorQuery.ParentBlockJoinByteVectorScorer.similarity
private final VectorSimilarityFunction	DiversifyingChildrenFloatKnnVectorQuery.DiversifyingChildrenFloatVectorScorer.similarity

Constructors in org.apache.lucene.search.join with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
protected	DiversifyingChildrenFloatVectorScorer(FloatVectorValues values, DocIdSetIterator acceptedChildrenIterator, BitSet parentBitSet, float[] query, VectorSimilarityFunction similarity)
protected	ParentBlockJoinByteVectorScorer(ByteVectorValues values, DocIdSetIterator acceptedChildrenIterator, BitSet parentBitSet, byte[] query, VectorSimilarityFunction similarity)

Uses of VectorSimilarityFunction in org.apache.lucene.util

Methods in org.apache.lucene.util with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
static ScalarQuantizedVectorSimilarity	ScalarQuantizedVectorSimilarity.fromVectorSimilarity(VectorSimilarityFunction sim, float constMultiplier)	Creates a ScalarQuantizedVectorSimilarity from a VectorSimilarityFunction and the constant multiplier used for quantization.
float	ScalarQuantizer.quantize(float[] src, byte[] dest, VectorSimilarityFunction similarityFunction)	Quantize a float vector into a byte vector
float	ScalarQuantizer.recalculateCorrectiveOffset(byte[] quantizedVector, ScalarQuantizer oldQuantizer, VectorSimilarityFunction similarityFunction)	Recalculate the old score corrective value given new current quantiles

Uses of VectorSimilarityFunction in org.apache.lucene.util.hnsw

Fields in org.apache.lucene.util.hnsw declared as VectorSimilarityFunction

Modifier and Type	Field	Description
private final VectorSimilarityFunction	RandomVectorScorerSupplier.ByteScoringSupplier.similarityFunction
private final VectorSimilarityFunction	RandomVectorScorerSupplier.FloatScoringSupplier.similarityFunction

Methods in org.apache.lucene.util.hnsw with parameters of type VectorSimilarityFunction

Modifier and Type	Method	Description
static RandomVectorScorer	RandomVectorScorer.createBytes(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction, byte[] query)	Creates a default scorer for byte vectors.
static RandomVectorScorerSupplier	RandomVectorScorerSupplier.createBytes(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction)	Creates a RandomVectorScorerSupplier to compare byte vectors.
static RandomVectorScorer	RandomVectorScorer.createFloats(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction, float[] query)	Creates a default scorer for float vectors.
static RandomVectorScorerSupplier	RandomVectorScorerSupplier.createFloats(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction)	Creates a RandomVectorScorerSupplier to compare float vectors.

Constructors in org.apache.lucene.util.hnsw with parameters of type VectorSimilarityFunction

Modifier	Constructor	Description
private	ByteScoringSupplier(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction)
private	FloatScoringSupplier(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction)