jsat.clustering

Class ClustererBase

java.lang.Object

jsat.clustering.ClustererBase

All Implemented Interfaces:

java.io.Serializable, Clusterer

Direct Known Subclasses:

DBSCAN, FLAME, KClustererBase, LSDBC, OPTICS

public abstract class ClustererBase
extends java.lang.Object
implements Clusterer

A base foundation that provides an implementation of Clusterer.cluster(jsat.DataSet) and #cluster(jsat.DataSet, java.util.concurrent.ExecutorService) using their int array counterparts.

By default it is assumed that a cluster does not support weighted data. If this is incorrect, you need to overwrite the Clusterer.supportsWeightedData() method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClustererBase()

Method Summary

Modifier and Type	Method and Description
abstract Clusterer	clone()
static java.util.List<java.util.List<DataPoint>>	createClusterListFromAssignmentArray(int[] assignments, DataSet dataSet) Convenient helper method.
static java.util.List<DataPoint>	getDatapointsFromCluster(int c, int[] assignments, DataSet dataSet, int[] indexFrom) Gets a list of the datapoints in a data set that belong to the indicated cluster

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jsat.clustering.Clusterer

cluster, cluster, cluster, cluster, supportsWeightedData

Constructor Detail

ClustererBase

public ClustererBase()

Method Detail

createClusterListFromAssignmentArray

public static java.util.List<java.util.List<DataPoint>> createClusterListFromAssignmentArray(int[] assignments,
                                                                                             DataSet dataSet)

Convenient helper method. A list of lists to represent a cluster may be desirable. In such a case, this method will take in an array of cluster assignments, and return a list of lists.

Parameters:

assignments - the array containing cluster assignments

dataSet - the original data set, with data in the same order as was used to create the assignments array

Returns:

a List of lists where each list contains the data points for one cluster, and the lists are in order by cluster id.

getDatapointsFromCluster

public static java.util.List<DataPoint> getDatapointsFromCluster(int c,
                                                                 int[] assignments,
                                                                 DataSet dataSet,
                                                                 int[] indexFrom)

Gets a list of the datapoints in a data set that belong to the indicated cluster

Parameters:

c - the cluster ID to get the datapoints for

assignments - the array containing cluster assignments

dataSet - the data set to get the points from

indexFrom - stores the index from the original dataset that the datapoint is from, such that the item at index i in the returned list can be found in the original dataset at index indexFrom[i]. May be null

Returns:

a list of datapoints that were assignment to the designated cluster

clone

public abstract Clusterer clone()

Specified by:

clone in interface Clusterer

Overrides:

clone in class java.lang.Object