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


com.chemaxon.clustering.common
Interface Cluster<T>

Type Parameters:
T - Type of elements contained by the clusters
All Known Subinterfaces:
HierarchicCluster<T>, IDBasedHierarchicCluster

@Beta
public interface Cluster<T>

Cluster represents a group of structures.

An instance of Cluster is considered a List of represented/referenced (nonnegative) structure IDs.

The represented group is immutable, so List modification operators are not supported, they throw UnsupportedOperationException upon calling.

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
 List<T> members()
          Represented members of this cluster.
 T representant()
          Cluster representant member.
 

Method Detail

members

List<T> members()
Represented members of this cluster.

Returns:
Immutable, non empty list of represented cluster members

representant

T representant()
Cluster representant member.

Please note that some clustering implementations might designate cluster representants arbitrarily without further considerations.

Returns:
An item from members() list designated as cluster representant.

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