Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Enum Class VectorIndex.SimilarityFunction

java.lang.Object

java.lang.Enum<VectorIndex.SimilarityFunction>

org.springframework.data.mongodb.core.index.VectorIndex.SimilarityFunction

All Implemented Interfaces:

Serializable, Comparable<VectorIndex.SimilarityFunction>, Constable

Enclosing class:

VectorIndex

public static enum VectorIndex.SimilarityFunction
extends Enum<VectorIndex.SimilarityFunction>

Similarity function used to calculate vector distance.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE
DOT_PRODUCT
EUCLIDEAN

Method Summary

Modifier and Type	Method	Description
String	getFunctionName()
static VectorIndex.SimilarityFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorIndex.SimilarityFunction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DOT_PRODUCT

public static final VectorIndex.SimilarityFunction DOT_PRODUCT

COSINE

public static final VectorIndex.SimilarityFunction COSINE

EUCLIDEAN

public static final VectorIndex.SimilarityFunction EUCLIDEAN

Method Details

values

public static VectorIndex.SimilarityFunction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static VectorIndex.SimilarityFunction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getFunctionName

public String getFunctionName()