jsat.clustering.hierarchical

Class SimpleHAC

java.lang.Object

jsat.clustering.ClustererBase

jsat.clustering.KClustererBase

jsat.clustering.hierarchical.SimpleHAC

All Implemented Interfaces:

Serializable, Clusterer, KClusterer

public class SimpleHAC
extends KClustererBase

Provides a naive implementation of hierarchical agglomerative clustering (HAC). This means the clustering is built from the bottom up, merging points into clusters. HAC clustering is deterministic. The naive implementation runs in O(n³) time.

NOTE: This implementation does not currently support parallel clustering.

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleHAC(ClusterDissimilarity disMeasure)
SimpleHAC(SimpleHAC toCopy) Copy constructor

Method Summary

Modifier and Type	Method and Description
SimpleHAC	clone()
int[]	cluster(DataSet dataSet, ExecutorService threadpool, int[] designations) Performs clustering on the given data set.
int[]	cluster(DataSet dataSet, int[] designations) Performs clustering on the given data set.
int[]	cluster(DataSet dataSet, int clusters, ExecutorService threadpool, int[] designations)
int[]	cluster(DataSet dataSet, int clusters, int[] designations)
int[]	cluster(DataSet dataSet, int lowK, int highK, ExecutorService threadpool, int[] designations)
int[]	cluster(DataSet dataSet, int lowK, int highK, int[] designations)

Methods inherited from class jsat.clustering.KClustererBase

cluster, cluster, cluster, cluster

Methods inherited from class jsat.clustering.ClustererBase

cluster, cluster, createClusterListFromAssignmentArray, getDatapointsFromCluster, supportsWeightedData

Methods inherited from class java.lang.Object

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

Methods inherited from interface jsat.clustering.Clusterer

cluster, cluster, supportsWeightedData

Constructor Detail

SimpleHAC

public SimpleHAC(ClusterDissimilarity disMeasure)

SimpleHAC

public SimpleHAC(SimpleHAC toCopy)

Copy constructor

Parameters:

toCopy - the object to copy

Method Detail

cluster

public int[] cluster(DataSet dataSet,
                     int[] designations)

Description copied from interface: Clusterer

Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.

Parameters:

dataSet - the data set to perform clustering on

designations - the array which will contain the designated values. The array will be altered and returned by the function. If null is given, a new array will be created and returned.

Returns:

an array indicating for each value indicating the cluster designation. This is the same array as designations, or a new one if the input array was null

cluster

public int[] cluster(DataSet dataSet,
                     ExecutorService threadpool,
                     int[] designations)

Description copied from interface: Clusterer

Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.

Parameters:

dataSet - the data set to perform clustering on

threadpool - a source of threads to run tasks

designations - the array which will contain the designated values. The array will be altered and returned by the function. If null is given, a new array will be created and returned.

Returns:

an array indicating for each value indicating the cluster designation. This is the same array as designations, or a new one if the input array was null

cluster

public int[] cluster(DataSet dataSet,
                     int clusters,
                     ExecutorService threadpool,
                     int[] designations)

cluster

public int[] cluster(DataSet dataSet,
                     int clusters,
                     int[] designations)

cluster

public int[] cluster(DataSet dataSet,
                     int lowK,
                     int highK,
                     ExecutorService threadpool,
                     int[] designations)

cluster

public int[] cluster(DataSet dataSet,
                     int lowK,
                     int highK,
                     int[] designations)

clone

public SimpleHAC clone()

Specified by:

clone in interface Clusterer

Specified by:

clone in interface KClusterer

Specified by:

clone in class KClustererBase