Package com.couchbase.lite

Enum Class VectorIndexConfiguration.DistanceMetric

java.lang.Object

java.lang.Enum<VectorIndexConfiguration.DistanceMetric>

com.couchbase.lite.VectorIndexConfiguration.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<VectorIndexConfiguration.DistanceMetric>, java.lang.constant.Constable

Enclosing class:

VectorIndexConfiguration

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

Distance metric to be used in the vector indexes.

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
DOT
EUCLIDEAN
EUCLIDEAN_SQUARED

Method Summary

Modifier and Type	Method	Description
String	getSQLName()
static VectorIndexConfiguration.DistanceMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorIndexConfiguration.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

EUCLIDEAN_SQUARED

public static final VectorIndexConfiguration.DistanceMetric EUCLIDEAN_SQUARED

COSINE

public static final VectorIndexConfiguration.DistanceMetric COSINE

EUCLIDEAN

public static final VectorIndexConfiguration.DistanceMetric EUCLIDEAN

DOT

public static final VectorIndexConfiguration.DistanceMetric DOT

Method Details

values

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

getSQLName

@NonNull
public String getSQLName()