edu.ucla.sspace.clustering

Interface Clustering

All Known Implementing Classes:

AutomaticStopClustering, BisectingKMeans, CKVWSpectralClustering03, CKVWSpectralClustering06, ClusteringByCommittee, ClutoClustering, DataMatrixLinkClustering, DirectClustering, GapStatistic, HierarchicalAgglomerativeClustering, LinkClustering, NeighborChainAgglomerativeClustering, Streemer

public interface Clustering

An interface for any Ofline clustering implementation. This interface supports hard and soft clustering by returning a Assignment. A Matrix is passed in where each row is to be considered the set of data points to cluster.

Implementations should not modify the contents of a Matrix to cluster. Implementations may use a passed in properties object to support additional parameters that for clustering. By convention, implementations should specify a set of default values such that the matrix rows can be clustered if no properties are specified.

If a clustering algorithm requires the number of clusters to be specified, an implementation may throw an UnsupportedOperationException when the number of clusters is not specified.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
Assignments	cluster(Matrix matrix, int numClusters, Properties props) Clusters the set of rows in the given Matrix into the specified number of clusters.
Assignments	cluster(Matrix matrix, Properties props) Clusters the set of rows in the given Matrix without a specified number of clusters (optional operation).

Method Detail

cluster

Assignments cluster(Matrix matrix,
                  Properties props)

Clusters the set of rows in the given Matrix without a specified number of clusters (optional operation). The set of cluster assignments are returned for each row in the matrix.

Parameters:

matrix - the Matrix whose row data points are to be clustered

props - the properties to use for any parameters each clustering algorithm may need

Returns:

an array of Assignment instances that indicate zero or more clusters to which each row belongs.

cluster

Assignments cluster(Matrix matrix,
                  int numClusters,
                  Properties props)

Clusters the set of rows in the given Matrix into the specified number of clusters. The set of cluster assignments are returned for each row in the matrix.

Parameters:

matrix - the Matrix whose row data points are to be clustered

numClusters - the number of clusters to generate

props - the properties to use for any parameters each clustering algorithm may need

Returns:

an array of Assignment instances that indicate zero or more clusters to which each row belongs.