Enum Class VectorIndexType.DistanceType

java.lang.Object

java.lang.Enum<VectorIndexType.DistanceType>

io.micronaut.data.annotation.VectorIndexType.DistanceType

All Implemented Interfaces:

Serializable, Comparable<VectorIndexType.DistanceType>, Constable

Enclosing class:

VectorIndexType

public static enum VectorIndexType.DistanceType
extends Enum<VectorIndexType.DistanceType>

Distance (similarity) metric to use for vector searches.

Since:

5.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE	Cosine distance/similarity metric.
DOT	Dot-product (inner product) metric.
L1_MANHATTAN	Manhattan (L1) distance metric.
L2_EUCLIDEAN	Euclidean (L2) distance metric.
L2_EUCLIDEAN_SQUARED	Squared Euclidean (L2) distance metric.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COSINE

public static final VectorIndexType.DistanceType COSINE

Cosine distance/similarity metric.

DOT

public static final VectorIndexType.DistanceType DOT

Dot-product (inner product) metric.

L1_MANHATTAN

public static final VectorIndexType.DistanceType L1_MANHATTAN

Manhattan (L1) distance metric.

L2_EUCLIDEAN_SQUARED

public static final VectorIndexType.DistanceType L2_EUCLIDEAN_SQUARED

Squared Euclidean (L2) distance metric.

L2_EUCLIDEAN

public static final VectorIndexType.DistanceType L2_EUCLIDEAN

Euclidean (L2) distance metric.

Method Details

values

public static VectorIndexType.DistanceType[] 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 VectorIndexType.DistanceType 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