Package org.zvec.binding

Enum Class MetricType

java.lang.Object

java.lang.Enum<MetricType>

org.zvec.binding.MetricType

All Implemented Interfaces:

Serializable, Comparable<MetricType>, Constable

public enum MetricType
extends Enum<MetricType>

Distance metric types. Maps to ZVEC_METRIC_TYPE_* in c_api.h.

Note: zvec_metric_type_to_string is NOT exported by the C library, so toStringName() is implemented in Java.

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
IP
L2
MIPSL2
UNDEFINED

Method Summary

Modifier and Type	Method	Description
static MetricType	fromCode(int code)
int	getCode()
String	toString()
String	toStringName()	Implemented in Java because the C symbol is not exported.
static MetricType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNDEFINED

public static final MetricType UNDEFINED

L2

public static final MetricType L2

IP

public static final MetricType IP

COSINE

public static final MetricType COSINE

MIPSL2

public static final MetricType MIPSL2

Method Details

values

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

getCode

public int getCode()

fromCode

public static MetricType fromCode(int code)

toStringName

public String toStringName()

Implemented in Java because the C symbol is not exported.

toString

public String toString()

Overrides:

toString in class Enum<MetricType>