Package org.springframework.data.elasticsearch.annotations

Enum Class KnnSimilarity

java.lang.Object

java.lang.Enum<KnnSimilarity>

org.springframework.data.elasticsearch.annotations.KnnSimilarity

All Implemented Interfaces:

Serializable, Comparable<KnnSimilarity>, Constable

public enum KnnSimilarity
extends Enum<KnnSimilarity>

Since:

5.4

Author:

Haibo Liu

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
DEFAULT
DOT_PRODUCT
L2_NORM
MAX_INNER_PRODUCT

Method Summary

Modifier and Type	Method	Description
String	getSimilarity()
static KnnSimilarity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KnnSimilarity[]	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

L2_NORM

public static final KnnSimilarity L2_NORM

DOT_PRODUCT

public static final KnnSimilarity DOT_PRODUCT

COSINE

public static final KnnSimilarity COSINE

MAX_INNER_PRODUCT

public static final KnnSimilarity MAX_INNER_PRODUCT

DEFAULT

public static final KnnSimilarity DEFAULT

Method Details

values

public static KnnSimilarity[] 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 KnnSimilarity 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

getSimilarity

public String getSimilarity()