Package com.redis.vl.schema

Enum Class VectorField.DistanceMetric

java.lang.Object

java.lang.Enum<VectorField.DistanceMetric>

com.redis.vl.schema.VectorField.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<VectorField.DistanceMetric>, Constable

Enclosing class:

VectorField

public static enum VectorField.DistanceMetric
extends Enum<VectorField.DistanceMetric>

Distance metrics for vector similarity

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	Cosine distance
IP	Inner Product distance
L2	L2 (Euclidean) distance

Method Summary

Modifier and Type	Method	Description
String	getValue()	Get the distance metric value
static VectorField.DistanceMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorField.DistanceMetric[]	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

public static final VectorField.DistanceMetric L2

L2 (Euclidean) distance

IP

public static final VectorField.DistanceMetric IP

Inner Product distance

COSINE

public static final VectorField.DistanceMetric COSINE

Cosine distance

Method Details

values

public static VectorField.DistanceMetric[] 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 VectorField.DistanceMetric 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

getValue

public String getValue()

Get the distance metric value

Returns:

Distance metric value