com.yworks.yfiles.algorithms

Enum Linkage

java.lang.Object

java.lang.Enum<Linkage>

com.yworks.yfiles.algorithms.Linkage

All Implemented Interfaces:

Serializable, Comparable<Linkage>

public enum Linkage
extends Enum<Linkage>

A specifier for single-linkage clustering.

See Also:

Groups.hierarchicalClustering(Graph, int, INodeMap, Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(Graph, Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(Graph, INodeMap, Groups.INodeDistanceProvider, Linkage, double)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE A specifier for average-linkage clustering.
COMPLETE A specifier for complete-linkage clustering.
SINGLE A specifier for single-linkage clustering.

Method Summary

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

AVERAGE

public static final Linkage AVERAGE

A specifier for average-linkage clustering.

At the beginning, each element belongs to its own cluster. At each step of the clustering algorithm the two most "similar" clusters are combined and the distance between them is defined as the average all distances between the nodes that belong to the two clusters that are combined. The algorithm continues until all nodes belong to the same cluster.

See Also:

Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, int, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage, double)

COMPLETE

public static final Linkage COMPLETE

A specifier for complete-linkage clustering.

At the beginning, each element belongs to its own cluster. At each step of the clustering algorithm the two most "dissimilar" clusters are merged and the distance equals to the distance of those two nodes that are farthest away from each other. The algorithm continues until all nodes belong to the same cluster.

See Also:

Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, int, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage, double)

SINGLE

public static final Linkage SINGLE

A specifier for single-linkage clustering.

At the beginning, each element belongs to its own cluster. At each step of the clustering algorithm the two most "similar" clusters are merged together until all nodes belong to the same cluster.

See Also:

Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, int, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage), Groups.hierarchicalClustering(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap, com.yworks.yfiles.algorithms.Groups.INodeDistanceProvider, Linkage, double)

Method Detail

fromOrdinal

public static final Linkage fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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