com.aliasi.cluster
Interface Clusterer<E>

Type Parameters:
E - the type of objects being clustered
All Known Subinterfaces:
HierarchicalClusterer<E>
All Known Implementing Classes:
AbstractHierarchicalClusterer, CompleteLinkClusterer, KMeansClusterer, SingleLinkClusterer

public interface Clusterer<E>

The Clusterer interface defines a means of clustering a set of input elements

Typically, the clusters returned by a clusterer will form a partition of the input elements. This means that the clusters will be disjoint (that is, have an empty intersection), and that elements and foundElements will be equal after the following:

 Clusterer<E> clusterer = ...
 Set<E> elements = ...
 Set<Set<E>> clusters = clusterer.cluster(elements);
 Set<E> foundElements = new HashSet<E>();
 for (Set<E> cluster : clusters)
     foundElements.addAll(cluster);
 elements.equals(foundElements); // true
 

Since:
LingPipe2.0
Version:
3.0
Author:
Bob Carpenter

Method Summary
 Set<Set<E>> cluster(Set<? extends E> elements)
          Return a clustering of the specified set of elements.
 

Method Detail

cluster

Set<Set<E>> cluster(Set<? extends E> elements)
Return a clustering of the specified set of elements.

Parameters:
elements - The objects to cluster.
Returns:
A clustering of the specified elements.