edu.ucla.sspace.clustering

Class ClutoClustering

java.lang.Object

edu.ucla.sspace.clustering.ClutoClustering

All Implemented Interfaces:

Clustering

public class ClutoClustering
extends Object
implements Clustering

A class for interacting with the CLUTO clustering library.

Author:

David Jurgens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClutoClustering.Criterion The crition function by which CLUTO should evaluate the clustering assignment.
static class	ClutoClustering.Method The method by which CLUTO should cluster the data points

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_CRITERION The property to set the name of a ClutoClustering.Criterion that Cluto should use in clustering the data.
static String	CLUSTER_METHOD The property to set the name of a ClutoClustering.Method that Cluto should use in clustering the data.
static String	PROPERTY_PREFIX A property prefix for specifiying options when using Cluto.

Constructor Summary

Constructors

Constructor and Description
ClutoClustering() Creates a new ClutoClustering instance.

Method Summary

Methods

Modifier and Type	Method and Description
Assignments	cluster(Matrix matrix, int numClusters, ClutoClustering.Method clusterMethod, ClutoClustering.Criterion criterionMethod) Clusters the set of rows in the given Matrix into a specified number of clusters using the specified CLUTO clustering method.
Assignments	cluster(Matrix matrix, int numClusters, Properties properties) Clusters the set of rows in the given Matrix into the specified number of clusters.
Assignments	cluster(Matrix matrix, Properties properties) Throws an UnsupportedOperationException if called, as CLUTO requires the number of clusters to be specified.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

A property prefix for specifiying options when using Cluto.

See Also:

Constant Field Values

CLUSTER_METHOD

public static final String CLUSTER_METHOD

The property to set the name of a ClutoClustering.Method that Cluto should use in clustering the data.

See Also:

Constant Field Values

CLUSTER_CRITERION

public static final String CLUSTER_CRITERION

The property to set the name of a ClutoClustering.Criterion that Cluto should use in clustering the data.

See Also:

Constant Field Values

Constructor Detail

ClutoClustering

public ClutoClustering()

Creates a new ClutoClustering instance.

Method Detail

cluster

public Assignments cluster(Matrix matrix,
                  Properties properties)

Throws an UnsupportedOperationException if called, as CLUTO requires the number of clusters to be specified.

Specified by:

cluster in interface Clustering

Parameters:

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

properties - 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

public Assignments cluster(Matrix matrix,
                  int numClusters,
                  Properties properties)

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.

Specified by:

cluster in interface Clustering

Parameters:

properties - the properties to use for clustering with CLUTO. See ClutoClustering for the list of supported properties.

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

numClusters - the number of clusters to generate

Returns:

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

cluster

public Assignments cluster(Matrix matrix,
                  int numClusters,
                  ClutoClustering.Method clusterMethod,
                  ClutoClustering.Criterion criterionMethod)

Clusters the set of rows in the given Matrix into a specified number of clusters using the specified CLUTO clustering method.

Parameters:

matrix - the Matrix containing data points to cluster

numClusters - the number of clusters to generate

clusterMethod - the method by which cluto should cluster the rows

Returns:

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