Module datarush.analytics

Package com.pervasive.datarush.analytics.cluster.kmeans

Enum Class DistanceMeasure

java.lang.Object

java.lang.Enum<DistanceMeasure>

com.pervasive.datarush.analytics.cluster.kmeans.DistanceMeasure

All Implemented Interfaces:

Serializable, Comparable<DistanceMeasure>, java.lang.constant.Constable

public enum DistanceMeasure
extends Enum<DistanceMeasure>

Enum of distance measure that can be used to build a k-means model.

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_SIMILARITY	Cosine similarity is used to calculate the distance between two points.
EUCLIDEAN	Euclidean distance is used to calculate the distance between two points.

Method Summary

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

Euclidean distance is used to calculate the distance between two points.

COSINE_SIMILARITY

public static final DistanceMeasure COSINE_SIMILARITY

Cosine similarity is used to calculate the distance between two points.

Method Details

values

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