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

Packages that use VectorSimilarityFunction

Package	Description
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.codecs.lucene90	Lucene 9.0 file format.
org.apache.lucene.codecs.lucene92	Lucene 9.2 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.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.

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 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 vectors, VectorSimilarityFunction similarityFunction, HnswGraph graphValues, Bits acceptOrds, int 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(RandomAccessVectorValuesProducer vectors, VectorSimilarityFunction similarityFunction, int maxConn, int beamWidth, long seed)	Reads all the vectors from a VectorValues, 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
private final VectorSimilarityFunction	Lucene91HnswGraphBuilder.similarityFunction
(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)
	Lucene91HnswGraphBuilder(RandomAccessVectorValuesProducer vectors, VectorSimilarityFunction similarityFunction, int maxConn, int beamWidth, long seed)	Reads all the vectors from a VectorValues, 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.codecs.lucene90

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

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

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

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

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

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

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

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

Modifier and Type	Method	Description
private OnHeapHnswGraph	Lucene92HnswVectorsWriter.writeGraph(RandomAccessVectorValuesProducer vectorValues, VectorSimilarityFunction similarityFunction)

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

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

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	KnnVectorField.createFieldType(int dimension, VectorSimilarityFunction similarityFunction)	A convenience method for creating a vector field type.
private static FieldType	KnnVectorField.createType(float[] v, VectorSimilarityFunction similarityFunction)
void	FieldType.setVectorDimensionsAndSimilarityFunction(int numDimensions, VectorSimilarityFunction distFunc)	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
	KnnVectorField(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
(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(VectorSimilarityFunction similarityFunction, int dimension)
(package private) static void	FieldInfo.verifySameVectorOptions(String fieldName, int vd1, VectorSimilarityFunction vsf1, int vd2, 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, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField)	Sole constructor.
(package private)	FieldVectorProperties(int numDimensions, VectorSimilarityFunction similarityFunction)

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	HnswGraphBuilder.similarityFunction
private final VectorSimilarityFunction	HnswGraphSearcher.similarityFunction

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

Modifier and Type	Method	Description
static NeighborQueue	HnswGraphSearcher.search(float[] query, int topK, RandomAccessVectorValues vectors, VectorSimilarityFunction similarityFunction, HnswGraph graph, Bits acceptOrds, int visitedLimit)	Searches HNSW graph for the nearest neighbors of a query vector.

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

Modifier	Constructor	Description
	HnswGraphBuilder(RandomAccessVectorValuesProducer vectors, VectorSimilarityFunction similarityFunction, int M, int beamWidth, long seed)	Reads all the vectors from a VectorValues, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.
	HnswGraphSearcher(VectorSimilarityFunction similarityFunction, NeighborQueue candidates, BitSet visited)	Creates a new graph searcher.