org.tribuo.common.nearest

Enum KNNTrainer.Distance

java.lang.Object

java.lang.Enum<KNNTrainer.Distance>

org.tribuo.common.nearest.KNNTrainer.Distance

All Implemented Interfaces:

Serializable, Comparable<KNNTrainer.Distance>

Enclosing class:

KNNTrainer<T extends Output<T>>

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

The available distance functions.

Enum Constant Summary

Enum Constants

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

Method Summary

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

L1

public static final KNNTrainer.Distance L1

L1 (or Manhattan) distance.

L2

public static final KNNTrainer.Distance L2

L2 (or Euclidean) distance.

COSINE

public static final KNNTrainer.Distance COSINE

Cosine similarity used as a distance measure.

Method Detail

values

public static KNNTrainer.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 (KNNTrainer.Distance c : KNNTrainer.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 KNNTrainer.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