Package com.hw.pinecone.entity.index

Enum Class Metric

java.lang.Object

java.lang.Enum<Metric>

com.hw.pinecone.entity.index.Metric

All Implemented Interfaces:

Serializable, Comparable<Metric>, Constable

public enum Metric
extends Enum<Metric>

The distance metric to be used for similarity search.

Author:

HamaWhite

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	Cosine metric.
DOTPRODUCT	Dotproduct metric.
EUCLIDEAN	Euclidean metric.

Method Summary

Modifier and Type	Method	Description
static Metric	fromValue(String value)
String	getValue()
static Metric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Metric[]	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

public static final Metric EUCLIDEAN

Euclidean metric.

COSINE

public static final Metric COSINE

Cosine metric.

DOTPRODUCT

public static final Metric DOTPRODUCT

Dotproduct metric.

Method Details

values

public static Metric[] 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 Metric 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

getValue

public String getValue()

fromValue

public static Metric fromValue(String value)