Enum DistanceFunction

java.lang.Object

java.lang.Enum<DistanceFunction>

software.amazon.awssdk.enhanced.dynamodb.model.DistanceFunction

All Implemented Interfaces:

Serializable, Comparable<DistanceFunction>

@SdkPublicApi
public enum DistanceFunction
extends Enum<DistanceFunction>

Distance function used for vector similarity search on a vector index.

See Also:

• EnhancedVectorIndex.distanceFunction()

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE
DOT_PRODUCT
EUCLIDEAN

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COSINE

public static final DistanceFunction COSINE

DOT_PRODUCT

public static final DistanceFunction DOT_PRODUCT

EUCLIDEAN

public static final DistanceFunction EUCLIDEAN

Method Details

values

public static DistanceFunction[] values()

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

Returns:

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

valueOf

public static DistanceFunction 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