io.lettuce.core.search.arguments

Enum VectorFieldArgs.DistanceMetric

java.lang.Object

java.lang.Enum<VectorFieldArgs.DistanceMetric>

io.lettuce.core.search.arguments.VectorFieldArgs.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<VectorFieldArgs.DistanceMetric>

Enclosing class:

VectorFieldArgs<K>

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

Distance metrics for vector similarity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COSINE Cosine similarity.
IP Inner product.
L2 Euclidean distance (L2 norm).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

L2

public static final VectorFieldArgs.DistanceMetric L2

Euclidean distance (L2 norm).

COSINE

public static final VectorFieldArgs.DistanceMetric COSINE

Cosine similarity.

IP

public static final VectorFieldArgs.DistanceMetric IP

Inner product.

Method Detail

values

public static VectorFieldArgs.DistanceMetric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VectorFieldArgs.DistanceMetric c : VectorFieldArgs.DistanceMetric.values())
    System.out.println(c);

Returns:

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

valueOf

public static VectorFieldArgs.DistanceMetric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null