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


com.chemaxon.clustering.common
Interface IDBasedHierarchicClustering

All Superinterfaces:
HierarchicClustering<Integer,IDBasedHierarchicCluster>

@Beta
public interface IDBasedHierarchicClustering
extends HierarchicClustering<Integer,IDBasedHierarchicCluster>

A Hierarchic clustering over integers, preferably IDs.

Please note that in order to help the implementation of higher level clustering representations represented clusters have associated, unique integer IDs.

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

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.chemaxon.clustering.common.HierarchicClustering
HierarchicClustering.Alignment
 
Method Summary
 int getMaxClusterID()
          Maximal ClusterID present in this clustering.
 int getMaxLeafID()
          Maximal leaf ID referenced in this clustering.
 IDBasedAssigner getPreferredAssigner()
          Preferred assigner.
 IDBasedAssigner unitPathAssigner()
          Assigner which consider parent-child edges as unit length.
 
Methods inherited from interface com.chemaxon.clustering.common.HierarchicClustering
clusterOf, preferredAlignment, roots
 

Method Detail

getMaxClusterID

int getMaxClusterID()
Maximal ClusterID present in this clustering.

Returns:
Maximal cluster ID present.

getMaxLeafID

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

Returns:
Maximal leaf ID referenced.

unitPathAssigner

IDBasedAssigner unitPathAssigner()
Description copied from interface: HierarchicClustering
Assigner which consider parent-child edges as unit length.

Specified by:
unitPathAssigner in interface HierarchicClustering<Integer,IDBasedHierarchicCluster>
Returns:
The unit path assigner.

getPreferredAssigner

IDBasedAssigner getPreferredAssigner()
Description copied from interface: HierarchicClustering
Preferred assigner.

Some clustering algorithms may assign meaningful levels for clusters/leaves. If no such assignment s done the implementations should fall back the unit path assigner.

Specified by:
getPreferredAssigner in interface HierarchicClustering<Integer,IDBasedHierarchicCluster>
Returns:
The preferred assigner

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