org.openimaj.ml.clustering.assignment

Interface SoftAssigner<DATATYPE,DISTANCES>

Type Parameters:

DATATYPE - the primitive array datatype which represents a centroid of this cluster.

DISTANCES - primitive array datatype for recording distances between points and cluster centroids.

All Superinterfaces:

Assigner<DATATYPE>

All Known Implementing Classes:

ByteKNNAssigner, DoubleKNNAssigner, FloatKNNAssigner, HierarchicalBytePathAssigner, HierarchicalDoublePathAssigner, HierarchicalFloatPathAssigner, HierarchicalIntPathAssigner, HierarchicalLongPathAssigner, HierarchicalShortPathAssigner, IntKNNAssigner, LongKNNAssigner, ShortKNNAssigner

public interface SoftAssigner<DATATYPE,DISTANCES>
extends Assigner<DATATYPE>

The SoftAssigner interface describes classes that assign a spatial point to multiple clusters, possibly with weighting.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
int[]	assign(DATATYPE data) Assign a single point to some clusters.
int[][]	assign(DATATYPE[] data) Assign data to clusters.
IndependentPair<int[],DISTANCES>	assignWeighted(DATATYPE data) Assign a single point to some clusters.
void	assignWeighted(DATATYPE[] data, int[][] assignments, DISTANCES[] weights) Assign data to clusters.
int	size() The number of clusters.

Methods inherited from interface org.openimaj.ml.clustering.assignment.Assigner

numDimensions

Method Detail

assign

int[][] assign(DATATYPE[] data)

Assign data to clusters.

Parameters:

data - the data.

Returns:

The cluster indices which the data was assigned to.

assign

int[] assign(DATATYPE data)

Assign a single point to some clusters.

Parameters:

data - datum to assign.

Returns:

the assigned cluster indices.

assignWeighted

void assignWeighted(DATATYPE[] data,
                    int[][] assignments,
                    DISTANCES[] weights)

Assign data to clusters. The results are returned in the indices and distances arrays. The return arrays must have the same length as the data array.

Parameters:

data - the data.

assignments - the cluster indices for each data point.

weights - the weights to the for each cluster for each data point.

assignWeighted

IndependentPair<int[],DISTANCES> assignWeighted(DATATYPE data)

Assign a single point to some clusters.

Parameters:

data - point to assign.

Returns:

the assigned cluster indices and weights.

size

int size()

The number of clusters.

Returns:

The number of clusters or unique ids that can be generated.