net.returnvoid.analytics

## Interface Clustering

- All Known Implementing Classes:
    ColorClustering

      public interface Clustering

  An interface to build clusterings.
  Author:
    Diana Lange

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Cluster` | `getCluster(java.lang.Object o)` Returns the cluster which is the most similar to the given parameter.
    `Cluster[]` | `getClusters()` Returns all clusters of this clustering.
    `int` | `getK()` The number of clusters to this clustering. k might differ from the getClusters().length, when empty clusters (clusters with no members) are automatically removed.
    `java.lang.Float` | `getLoss()` Returns the loss of the clustering (= mean loss of all clusters).

- - ### Method Detail

    - #### getLoss

          java.lang.Float getLoss()

      Returns the loss of the clustering (= mean loss of all clusters).
      Returns:
        The loss of the clustering.

    - #### getK

          int getK()

      The number of clusters to this clustering. k might differ from the getClusters().length, when empty clusters (clusters with no members) are automatically removed.
      Returns:
        The number of clusters.

    - #### getClusters

          Cluster[] getClusters()

      Returns all clusters of this clustering.
      Returns:
        The clusters.

    - #### getCluster

          Cluster getCluster(java.lang.Object o)

      Returns the cluster which is the most similar to the given parameter.
      Parameters:
        `o` - An element.
      Returns:
        The most similar cluster to the input or null if the input is not compatible to the data type of the cluster members.