com.chemaxon.clustering.common

Enum HierarchicClustering.Alignment

java.lang.Object

java.lang.Enum<HierarchicClustering.Alignment>

com.chemaxon.clustering.common.HierarchicClustering.Alignment

All Implemented Interfaces:

Serializable, Comparable<HierarchicClustering.Alignment>

Enclosing interface:

HierarchicClustering<T,C extends HierarchicCluster<T>>

@Beta
public static enum HierarchicClustering.Alignment
extends Enum<HierarchicClustering.Alignment>

Level interpretation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEAF_ALIGNED Leaves are aligned to level 0, level increases towards roots.
ROOT_ALIGNED Roots are aligned to level 0, level increases towards leaves.

Method Summary

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

ROOT_ALIGNED

public static final HierarchicClustering.Alignment ROOT_ALIGNED

Roots are aligned to level 0, level increases towards leaves.

LEAF_ALIGNED

public static final HierarchicClustering.Alignment LEAF_ALIGNED

Leaves are aligned to level 0, level increases towards roots.

Method Detail

values

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

Returns:

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

valueOf

public static HierarchicClustering.Alignment 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