Package org.tribuo.clustering.hdbscan

Enum Class HdbscanTrainer.Distance

java.lang.Object

java.lang.Enum<HdbscanTrainer.Distance>

org.tribuo.clustering.hdbscan.HdbscanTrainer.Distance

All Implemented Interfaces:

Serializable, Comparable<HdbscanTrainer.Distance>, Constable

Enclosing class:

HdbscanTrainer

public static enum HdbscanTrainer.Distance
extends Enum<HdbscanTrainer.Distance>

Available distance functions.

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 similarity as a distance measure.
EUCLIDEAN	Euclidean (or l2) distance.
L1	L1 (or Manhattan) distance.

Method Summary

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

Euclidean (or l2) distance.

COSINE

public static final HdbscanTrainer.Distance COSINE

Cosine similarity as a distance measure.

L1

public static final HdbscanTrainer.Distance L1

L1 (or Manhattan) distance.

Method Details

values

public static HdbscanTrainer.Distance[] 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 HdbscanTrainer.Distance 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