edu.ucla.sspace.clustering

Class OnlineKMeans.OnlineKMeansClustering<T extends DoubleVector>

java.lang.Object

edu.ucla.sspace.clustering.OnlineKMeans.OnlineKMeansClustering<T>

All Implemented Interfaces:

OnlineClustering<T>

Enclosing class:

OnlineKMeans<T extends DoubleVector>

public class OnlineKMeans.OnlineKMeansClustering<T extends DoubleVector>
extends Object
implements OnlineClustering<T>

A simple online implementation of K-Means clustering for Vectors, with the option to perform agglomerative clustering once all elements have been clustered.

Author:

Keith Stevens

Field Summary

Fields inherited from interface edu.ucla.sspace.clustering.OnlineClustering

NUM_CLUSTERS_PROPERTY, PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description
OnlineKMeans.OnlineKMeansClustering(double mergeThreshold, int maxNumClusters) Creates a new instance of online KMeans clustering.

Method Summary

Methods

Modifier and Type	Method and Description
int	addVector(T value) Adds value a cluster.
Cluster<T>	getCluster(int clusterIndex) Returns the Cluster with id clusterIndex.
List<Cluster<T>>	getClusters() Returns the list of all Clusters.
int	size() Returns the numeber of Clusters.
String	toString() Returns a string describing this ClusterMap.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnlineKMeans.OnlineKMeansClustering

public OnlineKMeans.OnlineKMeansClustering(double mergeThreshold,
                                   int maxNumClusters)

Creates a new instance of online KMeans clustering.

Method Detail

addVector

public int addVector(T value)

Adds value a cluster. The cluster may exist already or a new one may be generated. A unique identifier for the vector being clustered is returned. This identifier is to be used later on to query the cluster to which the value was assigned.

Specified by:

addVector in interface OnlineClustering<T extends DoubleVector>

getCluster

public Cluster<T> getCluster(int clusterIndex)

Returns the Cluster with id clusterIndex.

Specified by:

getCluster in interface OnlineClustering<T extends DoubleVector>

getClusters

public List<Cluster<T>> getClusters()

Returns the list of all Clusters.

Specified by:

getClusters in interface OnlineClustering<T extends DoubleVector>

size

public int size()

Returns the numeber of Clusters.

Specified by:

size in interface OnlineClustering<T extends DoubleVector>

toString

public String toString()

Returns a string describing this ClusterMap.

Overrides:

toString in class Object