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.bitvectors	A simple bit-vector format that supports hamming distance and storing vectors in an HNSW graph
org.apache.lucene.codecs.hnsw	HNSW vector helper classes.
org.apache.lucene.codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.codecs.lucene95	Lucene 9.5 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.sandbox.codecs.quantization	This package implements KMeans algorithm for clustering vectors
org.apache.lucene.util.quantization	Provides quantization methods for scaling vector values to smaller data types and possibly fewer dimensions

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
private final VectorSimilarityFunction	Lucene90HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
(package private) final VectorSimilarityFunction	Lucene90HnswVectorsReader.OffHeapFloatVectorValues.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)
VectorSimilarityFunction	Lucene90HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static Lucene90HnswVectorsReader.FieldEntry	Lucene90HnswVectorsReader.FieldEntry.create(DataInput input, VectorSimilarityFunction similarityFunction)
static NeighborQueue	Lucene90OnHeapHnswGraph.search(float[] query, int topK, int numSeed, FloatVectorValues 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
private	FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long indexDataOffset, long indexDataLength, int dimension, int[] ordToDoc, long[] ordOffsets)	Creates an instance of a FieldEntry record class.
	Lucene90HnswGraphBuilder(FloatVectorValues 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.
(package private)	OffHeapFloatVectorValues(int dimension, int[] ordToDoc, VectorSimilarityFunction similarityFunction, IndexInput dataIn)

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
private final VectorSimilarityFunction	Lucene91HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
private final VectorSimilarityFunction	Lucene91HnswVectorsReader.OffHeapFloatVectorValues.similarityFunction

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

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene91HnswVectorsReader.readSimilarityFunction(DataInput input)
VectorSimilarityFunction	Lucene91HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static Lucene91HnswVectorsReader.FieldEntry	Lucene91HnswVectorsReader.FieldEntry.create(DataInput input, VectorSimilarityFunction similarityFunction)

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

Modifier	Constructor	Description
private	FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int maxConn, int numLevels, int dimension, int size, int[] ordToDoc, IntUnaryOperator ordToDocOperator, int[][] nodesByLevel, long[] graphOffsetsByLevel)	Creates an instance of a FieldEntry record class.
(package private)	OffHeapFloatVectorValues(int dimension, int size, int[] ordToDoc, VectorSimilarityFunction similarityFunction, IndexInput dataIn)

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
private final VectorSimilarityFunction	Lucene92HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
protected final VectorSimilarityFunction	OffHeapFloatVectorValues.vectorSimilarityFunction

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

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene92HnswVectorsReader.readSimilarityFunction(DataInput input)
VectorSimilarityFunction	Lucene92HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static Lucene92HnswVectorsReader.FieldEntry	Lucene92HnswVectorsReader.FieldEntry.create(IndexInput input, VectorSimilarityFunction similarityFunction)

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

Modifier	Constructor	Description
	DenseOffHeapVectorValues(int dimension, int size, VectorSimilarityFunction vectorSimilarityFunction, IndexInput slice)
(package private)	FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength)	Creates an instance of a FieldEntry record class.
(package private)	OffHeapFloatVectorValues(int dimension, int size, VectorSimilarityFunction vectorSimilarityFunction, IndexInput slice)
	SparseOffHeapVectorValues(Lucene92HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, VectorSimilarityFunction vectorSimilarityFunction, IndexInput slice)

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
private final VectorSimilarityFunction	Lucene94HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
protected final VectorSimilarityFunction	OffHeapByteVectorValues.vectorSimilarityFunction
protected final VectorSimilarityFunction	OffHeapFloatVectorValues.vectorSimilarityFunction

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

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene94HnswVectorsReader.readSimilarityFunction(DataInput input)
VectorSimilarityFunction	Lucene94HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static Lucene94HnswVectorsReader.FieldEntry	Lucene94HnswVectorsReader.FieldEntry.create(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

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

Modifier	Constructor	Description
	DenseOffHeapVectorValues(int dimension, int size, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)
	DenseOffHeapVectorValues(int dimension, int size, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)
(package private)	FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength)	Creates an instance of a FieldEntry record class.
(package private)	OffHeapByteVectorValues(int dimension, int size, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)
(package private)	OffHeapFloatVectorValues(int dimension, int size, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)
	SparseOffHeapVectorValues(Lucene94HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)
	SparseOffHeapVectorValues(Lucene94HnswVectorsReader.FieldEntry fieldEntry, IndexInput dataIn, IndexInput slice, VectorSimilarityFunction vectorSimilarityFunction, int byteSize)

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
private final VectorSimilarityFunction	Lucene95HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.

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

Modifier and Type	Method	Description
private VectorSimilarityFunction	Lucene95HnswVectorsReader.readSimilarityFunction(DataInput input)
VectorSimilarityFunction	Lucene95HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static Lucene95HnswVectorsReader.FieldEntry	Lucene95HnswVectorsReader.FieldEntry.create(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

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

Modifier	Constructor	Description
(package private)	FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength, OrdToDocDISIReaderConfiguration ordToDocVectorValues)	Creates an instance of a FieldEntry record class.

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

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

Modifier and Type	Method	Description
RandomVectorScorer	FlatBitVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	FlatBitVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorerSupplier	FlatBitVectorsScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)

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

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

Modifier and Type	Field	Description
private final VectorSimilarityFunction	DefaultFlatVectorScorer.ByteScoringSupplier.similarityFunction
private final VectorSimilarityFunction	DefaultFlatVectorScorer.ByteVectorScorer.similarityFunction
private final VectorSimilarityFunction	DefaultFlatVectorScorer.FloatScoringSupplier.similarityFunction
private final VectorSimilarityFunction	DefaultFlatVectorScorer.FloatVectorScorer.similarityFunction
private final VectorSimilarityFunction	ScalarQuantizedVectorScorer.ScalarQuantizedRandomVectorScorerSupplier.vectorSimilarityFunction

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

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

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

Modifier	Constructor	Description
private	ByteScoringSupplier(ByteVectorValues vectors, VectorSimilarityFunction similarityFunction)
	ByteVectorScorer(ByteVectorValues values, byte[] query, VectorSimilarityFunction similarityFunction)
private	FloatScoringSupplier(FloatVectorValues vectors, VectorSimilarityFunction similarityFunction)
	FloatVectorScorer(FloatVectorValues values, float[] query, VectorSimilarityFunction similarityFunction)
	ScalarQuantizedRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, QuantizedByteVectorValues values)
private	ScalarQuantizedRandomVectorScorerSupplier(ScalarQuantizedVectorSimilarity similarity, VectorSimilarityFunction vectorSimilarityFunction, QuantizedByteVectorValues values)

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

Fields in org.apache.lucene.codecs.lucene94 with type parameters of type VectorSimilarityFunction

Modifier and Type	Field	Description
(package private) static final List<VectorSimilarityFunction>	Lucene94FieldInfosFormat.SIMILARITY_FUNCTIONS

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

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

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

Modifier and Type	Method	Description
(package private) static byte	Lucene94FieldInfosFormat.distFuncToOrd(VectorSimilarityFunction func)

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

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

Modifier and Type	Field	Description
protected final VectorSimilarityFunction	OffHeapByteVectorValues.similarityFunction
protected final VectorSimilarityFunction	OffHeapFloatVectorValues.similarityFunction

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

Modifier and Type	Method	Description
static OffHeapByteVectorValues	OffHeapByteVectorValues.load(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData)
static OffHeapFloatVectorValues	OffHeapFloatVectorValues.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 VectorSimilarityFunction

Modifier	Constructor	Description
	DenseOffHeapVectorValues(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)
	EmptyOffHeapVectorValues(int dimension, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction)
	EmptyOffHeapVectorValues(int dimension, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction)
(package private)	OffHeapByteVectorValues(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction)
(package private)	OffHeapFloatVectorValues(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction)
	SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration, IndexInput dataIn, IndexInput slice, int dimension, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction)
	SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration, IndexInput dataIn, IndexInput slice, int dimension, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction)

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

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

Modifier and Type	Field	Description
private final VectorSimilarityFunction	Lucene99FlatVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
private final VectorSimilarityFunction	Lucene99HnswVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.
protected final VectorSimilarityFunction	OffHeapQuantizedByteVectorValues.similarityFunction
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorScorer.ScalarQuantizedRandomVectorScorerSupplier.vectorSimilarityFunction
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues.vectorSimilarityFunction
private final VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues.vectorSimilarityFunction

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

Modifier and Type	Field	Description
static final List<VectorSimilarityFunction>	Lucene99HnswVectorsReader.SIMILARITY_FUNCTIONS

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

Modifier and Type	Method	Description
static VectorSimilarityFunction	Lucene99HnswVectorsReader.readSimilarityFunction(DataInput input)
VectorSimilarityFunction	Lucene99FlatVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.
VectorSimilarityFunction	Lucene99HnswVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.
VectorSimilarityFunction	Lucene99ScalarQuantizedVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier and Type	Method	Description
(package private) static ScalarQuantizer	Lucene99ScalarQuantizedVectorsWriter.buildScalarQuantizer(FloatVectorValues floatVectorValues, int numVectors, VectorSimilarityFunction vectorSimilarityFunction, Float confidenceInterval, byte bits)
(package private) static Lucene99HnswVectorsReader.FieldEntry	Lucene99HnswVectorsReader.FieldEntry.create(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
(package private) static Lucene99ScalarQuantizedVectorsReader.FieldEntry	Lucene99ScalarQuantizedVectorsReader.FieldEntry.create(IndexInput input, int versionMeta, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
(package private) static int	Lucene99HnswVectorsWriter.distFuncToOrd(VectorSimilarityFunction func)
(package private) static RandomVectorScorer	Lucene99ScalarQuantizedVectorScorer.fromVectorSimilarity(byte[] targetBytes, float offsetCorrection, VectorSimilarityFunction sim, float constMultiplier, QuantizedByteVectorValues values)
RandomVectorScorer	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorerSupplier	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)
static OffHeapQuantizedByteVectorValues	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 VectorSimilarityFunction

Modifier	Constructor	Description
	DenseOffHeapVectorValues(int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice)
	EmptyOffHeapVectorValues(int dimension, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer)
(package private)	FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, int dimension, int size, OrdToDocDISIReaderConfiguration ordToDoc, FieldInfo info)	Creates an instance of a FieldEntry record class.
private	FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength)	Creates an instance of a FieldEntry record class.
private	FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, ScalarQuantizer scalarQuantizer, int size, byte bits, boolean compress, OrdToDocDISIReaderConfiguration ordToDoc)	Creates an instance of a FieldEntry record class.
(package private)	OffHeapQuantizedByteVectorValues(int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, IndexInput slice)
(package private)	OffsetCorrectedQuantizedByteVectorValues(QuantizedByteVectorValues in, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer scalarQuantizer, ScalarQuantizer oldScalarQuantizer)
	QuantizedFloatVectorValues(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer)
	ScalarQuantizedRandomVectorScorerSupplier(QuantizedByteVectorValues values, VectorSimilarityFunction vectorSimilarityFunction)
	SparseOffHeapVectorValues(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, IndexInput dataIn, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice)

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

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

Modifier and Type	Field	Description
private final VectorSimilarityFunction	SimpleTextKnnVectorsReader.FieldEntry.similarityFunction	The field for the similarityFunction record component.

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

Modifier and Type	Method	Description
VectorSimilarityFunction	SimpleTextFieldInfosFormat.distanceFunction(String scoreFunction)
VectorSimilarityFunction	SimpleTextKnnVectorsReader.FieldEntry.similarityFunction()	Returns the value of the similarityFunction record component.

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

Modifier	Constructor	Description
private	FieldEntry(int dimension, long vectorDataOffset, long vectorDataLength, int[] ordToDoc, VectorSimilarityFunction similarityFunction)	Creates an instance of a FieldEntry record class.

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.

Uses of VectorSimilarityFunction in org.apache.lucene.index

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

Modifier and Type	Field	Description
private final VectorSimilarityFunction	FieldInfos.FieldVectorProperties.similarityFunction	The field for the similarityFunction record component.
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
VectorSimilarityFunction	FieldInfos.FieldVectorProperties.similarityFunction()	Returns the value of the similarityFunction record component.
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, 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.
private	FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)	Creates an instance of a FieldVectorProperties record class.

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.sandbox.codecs.quantization

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

Modifier and Type	Method	Description
static KMeans.Results	KMeans.cluster(FloatVectorValues vectors, VectorSimilarityFunction similarityFunction, int numClusters)	Cluster vectors into a given number of clusters

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

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

Modifier and Type	Field	Description
private final VectorSimilarityFunction	ScalarQuantizer.ScoreErrorCorrelator.function

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

Modifier and Type	Method	Description
private static float[]	ScalarQuantizer.candidateGridSearch(List<ScalarQuantizer.ScoreDocsAndScoreVariance> nearestNeighbors, List<float[]> vectors, float[] lowerCandidates, float[] upperCandidates, VectorSimilarityFunction function, byte bits)
private static List<ScalarQuantizer.ScoreDocsAndScoreVariance>	ScalarQuantizer.findNearestNeighbors(List<float[]> vectors, VectorSimilarityFunction similarityFunction)
static ScalarQuantizer	ScalarQuantizer.fromVectorsAutoInterval(FloatVectorValues floatVectorValues, VectorSimilarityFunction function, int totalVectorCount, byte bits)
static ScalarQuantizedVectorSimilarity	ScalarQuantizedVectorSimilarity.fromVectorSimilarity(VectorSimilarityFunction sim, float constMultiplier, byte bits)	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

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

Modifier	Constructor	Description
	ScoreErrorCorrelator(VectorSimilarityFunction function, List<ScalarQuantizer.ScoreDocsAndScoreVariance> nearestNeighbors, List<float[]> vectors, byte bits)