edu.ucla.sspace.clustering

Interface Cluster<T extends DoubleVector>

All Known Implementing Classes:

CentroidCluster, SynchronizedCluster

public interface Cluster<T extends DoubleVector>

An interface for representing a single cluster, which is composed of several data points. Each cluster is expected to always be capable of generating a centroid and a subset of vectors which were assigned to the cluster. The subset of assigned vectors may be empty. In addition, each cluster records the indentifier of every data point assigned to the cluster, allowing users the option of storing all potential Vectors when the Cluster itself may discard them and then performing additional operations on the vectors.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
void	addVector(T vector, int id) Adds vector with id to this Cluster.
T	centroid() Returns an immutable view of the centroid for this Cluster.
double	compareWithVector(T vector) Returns the similarity between this Cluster and vector.
BitSet	dataPointIds() Returns the set of identifiers for all data points assigned to this cluster.
List<T>	dataPointValues() Returns the set of stored data points, if any, for this cluster.
void	merge(Cluster<T> other) Merges the other Cluster with this Cluster.
int	size() Returns the total number of points assigned to this Cluster.

Method Detail

addVector

void addVector(T vector,
             int id)

Adds vector with id to this Cluster.

compareWithVector

double compareWithVector(T vector)

Returns the similarity between this Cluster and vector.

centroid

T centroid()

Returns an immutable view of the centroid for this Cluster.

dataPointValues

List<T> dataPointValues()

Returns the set of stored data points, if any, for this cluster.

dataPointIds

BitSet dataPointIds()

Returns the set of identifiers for all data points assigned to this cluster. TODO: Consider returning a set and let implementations return a wrapped BitSet, as in the graphical-update branch.

merge

void merge(Cluster<T> other)

Merges the other Cluster with this Cluster. This Cluster will absorb all data points from other and update the centroid and data point assignments as needed.

size

int size()

Returns the total number of points assigned to this Cluster.