Package com.cockroachlabs.data.ai

Enum Class DistanceMetric

java.lang.Object

java.lang.Enum<DistanceMetric>

com.cockroachlabs.data.ai.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<DistanceMetric>, Constable

public enum DistanceMetric
extends Enum<DistanceMetric>

Distance metrics for CockroachDB vector similarity search.

Each metric maps to a CockroachDB distance operator and an opclass name used in CREATE VECTOR INDEX DDL (CockroachDB v26.2+).

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
INNER_PRODUCT
L2

Method Summary

Modifier and Type	Method	Description
String	opclass()	Returns the CockroachDB opclass name for use in vector index DDL.
String	operator()
static DistanceMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static 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 DistanceMetric L2

COSINE

public static final DistanceMetric COSINE

INNER_PRODUCT

public static final DistanceMetric INNER_PRODUCT

Method Details

values

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

operator

public String operator()

opclass

public String opclass()

Returns the CockroachDB opclass name for use in vector index DDL. Example: vector_cosine_ops, vector_l2_ops, vector_ip_ops.