org.openimaj.ml.clustering.assignment

Interface HardAssigner<DATATYPE,DISTANCES,DISTANCE_INDEX>

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.

DISTANCE_INDEX - datatype for representing an pair.

All Superinterfaces:

Assigner<DATATYPE>

All Known Implementing Classes:

ClusterLimitedIntRAC, ConstrainedFloatAssigner, ExactByteAssigner, ExactDoubleAssigner, ExactFeatureVectorAssigner, ExactFloatAssigner, ExactIntAssigner, ExactLongAssigner, ExactShortAssigner, HierarchicalByteHardAssigner, HierarchicalDoubleHardAssigner, HierarchicalFloatHardAssigner, HierarchicalIntHardAssigner, HierarchicalLongHardAssigner, HierarchicalShortHardAssigner, IntRAC, IntRandomForest, KDTreeByteEuclideanAssigner, KDTreeDoubleEuclideanAssigner, KDTreeFloatEuclideanAssigner, KDTreeIntEuclideanAssigner, KDTreeLongEuclideanAssigner, KDTreeShortEuclideanAssigner

public interface HardAssigner<DATATYPE,DISTANCES,DISTANCE_INDEX>
extends Assigner<DATATYPE>

The HardAssigner interface describes classes that assign a spatial point to a single cluster.

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 a cluster.
int[]	assign(DATATYPE[] data) Assign data to a cluster.
DISTANCE_INDEX	assignDistance(DATATYPE data) Assign a single point to a cluster.
void	assignDistance(DATATYPE[] data, int[] indices, DISTANCES distances) Assign data to clusters.
int	size() The number of centroids or unique ids that can be generated.

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

numDimensions

Method Detail

assign

int[] assign(DATATYPE[] data)

Assign data to a cluster.

Parameters:

data - the data.

Returns:

The cluster indices which the data was assigned to.

assign

int assign(DATATYPE data)

Assign a single point to a cluster.

Parameters:

data - datum to assign.

Returns:

the cluster index.

assignDistance

void assignDistance(DATATYPE[] data,
                    int[] indices,
                    DISTANCES distances)

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.

indices - the cluster index for each data point.

distances - the distance to the closest cluster for each data point.

assignDistance

DISTANCE_INDEX assignDistance(DATATYPE data)

Assign a single point to a cluster.

Parameters:

data - point to assign.

Returns:

the cluster index and distance.

size

int size()

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

Returns:

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