de.lmu.ifi.dbs.elki.data

Class Clustering<M extends Model>

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.data.Clustering<M>

Type Parameters:

M - Model type

All Implemented Interfaces:

HierarchicalResult, Result

public class Clustering<M extends Model>
extends BasicResult

Result class for clusterings. Can be used for both hierarchical and non-hierarchical clusterings. The class does not enforce or rely on clusterings to be a tree or DAG, instead they can be an arbitrary forest of directed graphs that COULD contain cycles. This class is NOT iterable for a simple reason: there is more than one method to do so. You need to specify whether you want to use getToplevelClusters() or getAllClusters().

Since:

0.2

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private ModifiableHierarchy<Cluster<M>>	hierarchy Cluster hierarchy.
private java.util.List<Cluster<M>>	toplevelclusters Keep a list of top level clusters.
static SimpleTypeInformation<Clustering<?>>	TYPE Type information, for relation matching.

Constructor Summary

Constructors

Constructor and Description
Clustering(java.lang.String name, java.lang.String shortname) Constructor for an empty clustering
Clustering(java.lang.String name, java.lang.String shortname, java.util.List<Cluster<M>> toplevelclusters) Constructor with a list of top level clusters

Method Summary

Modifier and Type	Method and Description
void	addChildCluster(Cluster<M> parent, Cluster<M> child) Add a cluster to the clustering.
void	addToplevelCluster(Cluster<M> clus) Add a cluster to the clustering.
java.util.List<Cluster<M>>	getAllClusters() Collect all clusters (recursively) into a List.
Hierarchy<Cluster<M>>	getClusterHierarchy() Get the cluster hierarchy.
static java.util.List<Clustering<? extends Model>>	getClusteringResults(Result r) Collect all clustering results from a Result
java.util.List<Cluster<M>>	getToplevelClusters() Return top level clusters
It<Cluster<M>>	iterToplevelClusters() Iterate over the top level clusters.

Methods inherited from class de.lmu.ifi.dbs.elki.result.BasicResult

getLongName, getShortName

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final SimpleTypeInformation<Clustering<?>> TYPE

Type information, for relation matching.

toplevelclusters

private java.util.List<Cluster<M extends Model>> toplevelclusters

Keep a list of top level clusters.

hierarchy

private ModifiableHierarchy<Cluster<M extends Model>> hierarchy

Cluster hierarchy.

Constructor Detail

Clustering

public Clustering(java.lang.String name,
                  java.lang.String shortname,
                  java.util.List<Cluster<M>> toplevelclusters)

Constructor with a list of top level clusters

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

toplevelclusters - Top level clusters

Clustering

public Clustering(java.lang.String name,
                  java.lang.String shortname)

Constructor for an empty clustering

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

Method Detail

addToplevelCluster

public void addToplevelCluster(Cluster<M> clus)

Add a cluster to the clustering.

Parameters:

clus - new cluster

addChildCluster

public void addChildCluster(Cluster<M> parent,
                            Cluster<M> child)

Add a cluster to the clustering.

Parameters:

parent - Parent cluster

child - Child cluster.

getToplevelClusters

public java.util.List<Cluster<M>> getToplevelClusters()

Return top level clusters

Returns:

top level clusters

getClusterHierarchy

public Hierarchy<Cluster<M>> getClusterHierarchy()

Get the cluster hierarchy.

Returns:

Cluster hierarchy.

getAllClusters

public java.util.List<Cluster<M>> getAllClusters()

Collect all clusters (recursively) into a List.

Returns:

List of all clusters.

iterToplevelClusters

public It<Cluster<M>> iterToplevelClusters()

Iterate over the top level clusters.

Returns:

Iterator

getClusteringResults

public static java.util.List<Clustering<? extends Model>> getClusteringResults(Result r)

Collect all clustering results from a Result

Parameters:

r - Result

Returns:

List of clustering results