org.tribuo.clustering.kmeans

Enum KMeansTrainer.Distance

java.lang.Object

java.lang.Enum<KMeansTrainer.Distance>

org.tribuo.clustering.kmeans.KMeansTrainer.Distance

All Implemented Interfaces:

Serializable, Comparable<KMeansTrainer.Distance>

Enclosing class:

KMeansTrainer

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

Possible distance functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COSINE Cosine similarity as a distance measure.
EUCLIDEAN Euclidean (or l2) distance.
L1 L1 (or Manhattan) distance.

Method Summary

Modifier and Type	Method and Description
static KMeansTrainer.Distance	valueOf(String name) Returns the enum constant of this type with the specified name.
static KMeansTrainer.Distance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EUCLIDEAN

public static final KMeansTrainer.Distance EUCLIDEAN

Euclidean (or l2) distance.

COSINE

public static final KMeansTrainer.Distance COSINE

Cosine similarity as a distance measure.

L1

public static final KMeansTrainer.Distance L1

L1 (or Manhattan) distance.

Method Detail

values

public static KMeansTrainer.Distance[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KMeansTrainer.Distance c : KMeansTrainer.Distance.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KMeansTrainer.Distance valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null