com.yworks.yfiles.algorithms

Enum DistanceMetric

java.lang.Object

java.lang.Enum<DistanceMetric>

com.yworks.yfiles.algorithms.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<DistanceMetric>

public enum DistanceMetric
extends Enum<DistanceMetric>

See Also:

Groups.kMeansClustering(Graph, INodeMap, IDataProvider, DistanceMetric, int, int, YPoint[])

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHEBYCHEV A specifier for Chebychev distance metric.
EUCLIDEAN A specifier for euclidean distance metric.
EUCLIDEAN_SQUARED A specifier for euclidean squared distance metric.
MANHATTAN A specifier for Manhattan distance metric.

Method Summary

Modifier and Type	Method and Description
static DistanceMetric	fromOrdinal(int ordinal)
int	value()
static DistanceMetric	valueOf(String name) Returns the enum constant of this type with the specified name.
static DistanceMetric[]	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

CHEBYCHEV

public static final DistanceMetric CHEBYCHEV

A specifier for Chebychev distance metric.

See Also:

Groups.kMeansClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.IDataProvider, DistanceMetric, int, int, com.yworks.yfiles.algorithms.YPoint[])

EUCLIDEAN

public static final DistanceMetric EUCLIDEAN

A specifier for euclidean distance metric.

See Also:

Groups.kMeansClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.IDataProvider, DistanceMetric, int, int, com.yworks.yfiles.algorithms.YPoint[])

EUCLIDEAN_SQUARED

public static final DistanceMetric EUCLIDEAN_SQUARED

A specifier for euclidean squared distance metric.

See Also:

Groups.kMeansClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.IDataProvider, DistanceMetric, int, int, com.yworks.yfiles.algorithms.YPoint[])

MANHATTAN

public static final DistanceMetric MANHATTAN

A specifier for Manhattan distance metric.

See Also:

Groups.kMeansClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.IDataProvider, DistanceMetric, int, int, com.yworks.yfiles.algorithms.YPoint[])

Method Detail

fromOrdinal

public static final DistanceMetric fromOrdinal(int ordinal)

value

public int value()

valueOf

public static DistanceMetric 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.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static DistanceMetric[] 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 (DistanceMetric c : DistanceMetric.values())
    System.out.println(c);

Returns:

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