package jsat.clustering;
import java.io.Serializable;
import java.util.List;
import java.util.concurrent.ExecutorService;
import jsat.DataSet;
import jsat.classifiers.DataPoint;
import static jsat.clustering.ClustererBase.createClusterListFromAssignmentArray;
/**
* Defines the interface for a generic clustering algorithm.
*
* @author Edward Raff
*/
public interface Clusterer extends Serializable
{
/**
* Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.
*
* @param dataSet the data set to perform clustering on
* @return A list of clusters found by this method.
*/
default public List> cluster(DataSet dataSet)
{
return cluster(dataSet, false);
}
/**
* Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.
*
* @param dataSet the data set to perform clustering on
* @param designations the array which will contain the designated values. The array will be altered and returned by
* the function. If null is given, a new array will be created and returned.
* @return an array indicating for each value indicating the cluster designation. This is the same array as
* designations, or a new one if the input array was null
*/
default public int[] cluster(DataSet dataSet, int[] designations)
{
return cluster(dataSet, false, designations);
}
/**
* Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.
*
* @param dataSet the data set to perform clustering on
* @param parallel {@code true} if multiple threads should be used to
* perform clustering. {@code false} if it should be done in a single
* threaded manner.
* @return the java.util.List>
*/
default public List> cluster(DataSet dataSet, boolean parallel)
{
int[] assignments = cluster(dataSet, parallel, (int[]) null);
return createClusterListFromAssignmentArray(assignments, dataSet);
}
/**
* Performs clustering on the given data set. Parameters may be estimated by the method, or other heuristics performed.
*
* @param dataSet the data set to perform clustering on
* @param parallel {@code true} if multiple threads should be used to
* perform clustering. {@code false} if it should be done in a single
* threaded manner.
* @param designations the array which will contain the designated values.
* The array will be altered and returned by the function. If null is given, a new array will be created and returned.
* @return the int[]
*/
public int[] cluster(DataSet dataSet, boolean parallel, int[] designations);
/**
* Indicates whether the model knows how to cluster using weighted data
* points. If it does, the model will train assuming the weights. The values
* returned by this method may change depending on the parameters set for
* the model.
*
* @return true if the model supports weighted data, false
* otherwise
*/
default public boolean supportsWeightedData()
{
return false;
}
public Clusterer clone();
}
Ads help maintain this website.