Package com.yahoo.schema.document

Enum Class Attribute.DistanceMetric

java.lang.Object

java.lang.Enum<Attribute.DistanceMetric>

com.yahoo.schema.document.Attribute.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<Attribute.DistanceMetric>, Constable

Enclosing class:

Attribute

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

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
ANGULAR
DOTPRODUCT
EUCLIDEAN
GEODEGREES
HAMMING
INNERPRODUCT
PRENORMALIZED_ANGULAR

Method Summary

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

public static final Attribute.DistanceMetric EUCLIDEAN

ANGULAR

public static final Attribute.DistanceMetric ANGULAR

GEODEGREES

public static final Attribute.DistanceMetric GEODEGREES

INNERPRODUCT

public static final Attribute.DistanceMetric INNERPRODUCT

HAMMING

public static final Attribute.DistanceMetric HAMMING

PRENORMALIZED_ANGULAR

public static final Attribute.DistanceMetric PRENORMALIZED_ANGULAR

DOTPRODUCT

public static final Attribute.DistanceMetric DOTPRODUCT

Method Details

values

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