org.openimaj.ml.clustering.assignment.hard

Class HierarchicalFloatHardAssigner

java.lang.Object

org.openimaj.ml.clustering.assignment.hard.HierarchicalFloatHardAssigner

All Implemented Interfaces:

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

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

The HierarchicalFloatHardAssigner is a HardAssigner for HierarchicalFloatKMeansResult instances. The assigner produces the index of the assigned leaf node as if the clusters were actually flat.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HierarchicalFloatHardAssigner.ScoringScheme The HierarchicalFloatHardAssigner.ScoringScheme determines how the distance to a cluster is estimated from the hierarchy of k-means generated clusters.

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchicalFloatPathAssigner	path
protected HierarchicalFloatKMeansResult	result
protected HierarchicalFloatHardAssigner.ScoringScheme	scorer

Constructor Summary

Constructors

Constructor and Description
HierarchicalFloatHardAssigner(HierarchicalFloatKMeansResult result) Construct with the given Hierarchical KMeans clusterer and the SUM scoring scheme.
HierarchicalFloatHardAssigner(HierarchicalFloatKMeansResult result, HierarchicalFloatHardAssigner.ScoringScheme scorer) Construct with the given hierarchical KMeans clusterer and scoring scheme.

Method Summary

Modifier and Type	Method and Description
int	assign(float[] data) Assign a single point to a cluster.
int[]	assign(float[][] data) Assign data to a cluster.
IntFloatPair	assignDistance(float[] data) Assign a single point to a cluster.
void	assignDistance(float[][] data, int[] indices, float[] distances) Assign data to clusters.
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

result

protected HierarchicalFloatKMeansResult result

path

protected HierarchicalFloatPathAssigner path

scorer

protected HierarchicalFloatHardAssigner.ScoringScheme scorer

Constructor Detail

HierarchicalFloatHardAssigner

public HierarchicalFloatHardAssigner(HierarchicalFloatKMeansResult result,
                                     HierarchicalFloatHardAssigner.ScoringScheme scorer)

Construct with the given hierarchical KMeans clusterer and scoring scheme.

Parameters:

result - the hierarchical KMeans clusterer

scorer - the scoring scheme

HierarchicalFloatHardAssigner

public HierarchicalFloatHardAssigner(HierarchicalFloatKMeansResult result)

Construct with the given Hierarchical KMeans clusterer and the SUM scoring scheme.

Parameters:

result - the hierarchical KMeans clusterer

Method Detail

assign

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

Description copied from interface: HardAssigner

Assign data to a cluster.

Specified by:

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

Parameters:

data - the data.

Returns:

The cluster indices which the data was assigned to.

assign

public int assign(float[] data)

Description copied from interface: HardAssigner

Assign a single point to a cluster.

Specified by:

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

Parameters:

data - datum to assign.

Returns:

the cluster index.

assignDistance

public void assignDistance(float[][] 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<float[],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(float[] data)

Description copied from interface: HardAssigner

Assign a single point to a cluster.

Specified by:

assignDistance in interface HardAssigner<float[],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<float[],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<float[]>

Returns:

the number of dimensions