org.openimaj.ml.clustering.assignment.hard

Class ExactIntAssigner

java.lang.Object

org.openimaj.ml.clustering.assignment.hard.ExactIntAssigner

All Implemented Interfaces:

Assigner<int[]>, HardAssigner<int[],float[],IntFloatPair>

public class ExactIntAssigner
extends Object
implements HardAssigner<int[],float[],IntFloatPair>

A HardAssigner that assigns points to the closest cluster based on the distance to the centroid.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected IntNearestNeighboursExact	nn

Constructor Summary

Constructors

Constructor and Description
ExactIntAssigner(CentroidsProvider<int[]> provider) Construct the assigner using the given cluster data.
ExactIntAssigner(CentroidsProvider<int[]> provider, IntFVComparator comparison) Construct the assigner using the given cluster data and distance function.
ExactIntAssigner(int[][] data, IntFVComparator comparison) Construct the assigner using the given cluster data and distance function.

Method Summary

Modifier and Type	Method and Description
int	assign(int[] data) Assign a single point to a cluster.
int[]	assign(int[][] data) Assign data to a cluster.
IntFloatPair	assignDistance(int[] data) Assign a single point to a cluster.
void	assignDistance(int[][] data, int[] indices, float[] distances) Assign data to clusters.
IntNearestNeighboursExact	getNN() Get the underlying nearest-neighbour implementation.
int	numDimensions() Get the number of dimensions of the input vectors.
int	size() The number of centroids or unique ids that can be generated.

Methods inherited from class java.lang.Object

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

Field Detail

nn

protected IntNearestNeighboursExact nn

Constructor Detail

ExactIntAssigner

public ExactIntAssigner(CentroidsProvider<int[]> provider)

Construct the assigner using the given cluster data. The distance function defaults to Euclidean.

Parameters:

provider - the cluster data provider

ExactIntAssigner

public ExactIntAssigner(CentroidsProvider<int[]> provider,
                        IntFVComparator comparison)

Construct the assigner using the given cluster data and distance function.

Parameters:

provider - the cluster data provider

comparison - the distance function

ExactIntAssigner

public ExactIntAssigner(int[][] data,
                        IntFVComparator comparison)

Construct the assigner using the given cluster data and distance function.

Parameters:

data - the cluster data

comparison - the distance function

Method Detail

assign

public int[] assign(int[][] data)

Description copied from interface: HardAssigner

Assign data to a cluster.

Specified by:

assign in interface HardAssigner<int[],float[],IntFloatPair>

Parameters:

data - the data.

Returns:

The cluster indices which the data was assigned to.

assign

public int assign(int[] data)

Description copied from interface: HardAssigner

Assign a single point to a cluster.

Specified by:

assign in interface HardAssigner<int[],float[],IntFloatPair>

Parameters:

data - datum to assign.

Returns:

the cluster index.

assignDistance

public void assignDistance(int[][] data,
                           int[] indices,
                           float[] distances)

Description copied from interface: HardAssigner

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.

Specified by:

assignDistance in interface HardAssigner<int[],float[],IntFloatPair>

Parameters:

data - the data.

indices - the cluster index for each data point.

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

assignDistance

public IntFloatPair assignDistance(int[] data)

Description copied from interface: HardAssigner

Assign a single point to a cluster.

Specified by:

assignDistance in interface HardAssigner<int[],float[],IntFloatPair>

Parameters:

data - point to assign.

Returns:

the cluster index and distance.

size

public int size()

Description copied from interface: HardAssigner

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

Specified by:

size in interface HardAssigner<int[],float[],IntFloatPair>

Returns:

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

numDimensions

public int numDimensions()

Description copied from interface: Assigner

Get the number of dimensions of the input vectors.

Specified by:

numDimensions in interface Assigner<int[]>

Returns:

the number of dimensions

getNN

public IntNearestNeighboursExact getNN()

Get the underlying nearest-neighbour implementation.

Returns:

the underlying nearest-neighbour implementation.