javax.datamining.algorithm.kmeans
Class ClusteringDistanceFunction

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.algorithm.kmeans.ClusteringDistanceFunction

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class ClusteringDistanceFunction

extends Enum

The enumeration ClusteringDistanceFunction represents the distance functions used to compute the distance between two points when building a clustering model.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Serialized Form

Field Summary

static ClusteringDistanceFunction	euclidean
static ClusteringDistanceFunction	systemDefault
static ClusteringDistanceFunction	systemDetermined

Method Summary

static void	addExtension(java.lang.String name) Adds a vendor extension name to ClusteringDistanceFunction.
static ClusteringDistanceFunction	valueOf(java.lang.String name) Returns an instance of ClusteringDistanceFunction corresponding to the specified name.
static ClusteringDistanceFunction[]	values() Returns a list of all ClusteringDistanceFunction enumerations defined.

Methods inherited from class javax.datamining.Enum

compareTo, equals, name

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

euclidean

public static final ClusteringDistanceFunction euclidean

systemDefault

public static final ClusteringDistanceFunction systemDefault

systemDetermined

public static final ClusteringDistanceFunction systemDetermined

Method Detail

addExtension

public static void addExtension(java.lang.String name)
                         throws JDMException

Adds a vendor extension name to ClusteringDistanceFunction.

Parameters:

name - The name of the unique vendor extension

Throws:

JDMException - When name is an invalid string or redundant to existing standard enums.

valueOf

public static ClusteringDistanceFunction valueOf(java.lang.String name)
                                          throws JDMException

Returns an instance of ClusteringDistanceFunction corresponding to the specified name.

Parameters:

name - The name of the enumeration value

Returns:

ClusteringDistanceFunction - The instance of the specified enumeration.

Throws:

JDMException - When name is not valid.

values

public static ClusteringDistanceFunction[] values()

Returns a list of all ClusteringDistanceFunction enumerations defined.

Returns:

ClusteringDistanceFunction[]