edu.ucla.sspace.clustering

Interface OnlineClustering<T extends DoubleVector>

All Known Implementing Classes:

OnlineKMeans.OnlineKMeansClustering, StreamingKMeans.StreamingKMeansClustering

public interface OnlineClustering<T extends DoubleVector>

An interface for any Online clustering implementation. When a vector is added to a specific cluster, implementations are suggested to return a unique cluster id specifying what cluster the item was assigned to. At any time, users of an OnlineCustering instance may request one or all of the centroids. These centroids may be created per request or maintained internally at all times.

Implementations are expected to be thread-safe.

Author:

Keith Stevens

Field Summary

Fields

Modifier and Type	Field and Description
static String	NUM_CLUSTERS_PROPERTY
static String	PROPERTY_PREFIX

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.

Field Detail

PROPERTY_PREFIX

static final String PROPERTY_PREFIX

See Also:

Constant Field Values

NUM_CLUSTERS_PROPERTY

static final String NUM_CLUSTERS_PROPERTY

See Also:

Constant Field Values

Method Detail

addVector

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.

getCluster

Cluster<T> getCluster(int clusterIndex)

Returns the Cluster with id clusterIndex.

getClusters

List<Cluster<T>> getClusters()

Returns the list of all Clusters.

size

int size()

Returns the numeber of Clusters.