org.openimaj.ml.clustering.kmeans

Class FloatKMeans.Result

java.lang.Object

org.openimaj.ml.clustering.FloatCentroidsResult

org.openimaj.ml.clustering.kmeans.FloatKMeans.Result

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, FloatNearestNeighboursProvider, CentroidsProvider<float[]>, Clusters, SpatialClusters<float[]>

Enclosing class:

FloatKMeans

public static class FloatKMeans.Result
extends FloatCentroidsResult
implements FloatNearestNeighboursProvider

Result object for FloatKMeans, extending FloatCentroidsResult and FloatNearestNeighboursProvider, as well as giving access to state information from the operation of the K-Means algorithm (i.e. number of iterations, and convergence state).

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	changedCentroidCount
protected int	iterations
protected FloatNearestNeighbours	nn

Fields inherited from class org.openimaj.ml.clustering.FloatCentroidsResult

centroids

Fields inherited from interface org.openimaj.ml.clustering.Clusters

CLUSTER_HEADER

Constructor Summary

Constructors

Constructor and Description
Result()

Method Summary

Modifier and Type	Method and Description
HardAssigner<float[],float[],IntFloatPair>	defaultHardAssigner() Get the default hard assigner for this clusterer.
FloatNearestNeighbours	getNearestNeighbours()
int	numChangedCentroids() Get the number of changed centroids in the last iteration.
int	numIterations() Get the number of K-Means iterations that produced this result.

Methods inherited from class org.openimaj.ml.clustering.FloatCentroidsResult

asciiHeader, binaryHeader, equals, getCentroids, numClusters, numDimensions, readASCII, readBinary, toString, writeASCII, writeBinary

Methods inherited from class java.lang.Object

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

Field Detail

nn

protected FloatNearestNeighbours nn

iterations

protected int iterations

changedCentroidCount

protected int changedCentroidCount

Constructor Detail

Result

public Result()

Method Detail

defaultHardAssigner

public HardAssigner<float[],float[],IntFloatPair> defaultHardAssigner()

Description copied from interface: SpatialClusters

Get the default hard assigner for this clusterer. This method is potentially expensive, so callers should only call it once, and hold on to the result (and reuse it).

Specified by:

defaultHardAssigner in interface SpatialClusters<float[]>

Overrides:

defaultHardAssigner in class FloatCentroidsResult

Returns:

a hard assigner.

getNearestNeighbours

public FloatNearestNeighbours getNearestNeighbours()

Specified by:

getNearestNeighbours in interface FloatNearestNeighboursProvider

Returns:

the underlying nearest neighbour object

numIterations

public int numIterations()

Get the number of K-Means iterations that produced this result.

Returns:

the number of iterations

numChangedCentroids

public int numChangedCentroids()

Get the number of changed centroids in the last iteration. This is an indicator of convergence as over time this should reduce to 0.

Returns:

the number of changed centroids