jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.clustering.common
Interface IDBasedHierarchy


@Beta
interface IDBasedHierarchy

Instances represent the structure of an ID based hierarchic clustering.

To construct an immutable IDBasedHierarchicClustering one usually need to traverse the clustering hierarchy - for example to construct efficient immutable IDBasedAssigner instances. This interface represents the structure of the clustering without other references to such delegated functionalities to provide an easy to use intermediate representation.

Please note that this interface is marked with @Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Author:
Gabor Imre

Method Summary
 Optional<IDBasedHierarchicCluster> clusterOf(Integer item)
          Identify the lowest level cluster containing the given item.
 int getMaxClusterID()
          Maximal ClusterID present in this clustering.
 int getMaxLeafID()
          Maximal lead ID referenced in this clustering.
 HierarchicClustering.Alignment preferredAlignment()
          Preferred alignment of the represented clustering.
 List<IDBasedHierarchicCluster> roots()
          Roots of the clustering.
 

Method Detail

getMaxClusterID

int getMaxClusterID()
Maximal ClusterID present in this clustering.

Returns:
Maximal cluster ID present.

getMaxLeafID

int getMaxLeafID()
Maximal lead ID referenced in this clustering.

Returns:
Maximal leaf ID referenced.

roots

List<IDBasedHierarchicCluster> roots()
Roots of the clustering.

Returns:
List of roots

clusterOf

Optional<IDBasedHierarchicCluster> clusterOf(Integer item)
Identify the lowest level cluster containing the given item.

Parameters:
item - Item to look up.
Returns:
The lowest level cluster containing the given element. This cluster contains the given item as a leaf.

preferredAlignment

HierarchicClustering.Alignment preferredAlignment()
Preferred alignment of the represented clustering.

Returns:
Preferred alignment

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)