oracle.spatial.hadoop.vector.cluster.kmeans

Class EuclideanDistanceCriterionFunction

java.lang.Object

oracle.spatial.hadoop.vector.cluster.kmeans.EuclideanDistanceCriterionFunction

All Implemented Interfaces:

CriterionFunction

public class EuclideanDistanceCriterionFunction
extends java.lang.Object
implements CriterionFunction

A CriterionFunction implementation based on the uclidian distance between the last two cluster centers. The function will converge when the euclidean distance between the cluster centers of two consecutive iterations is equal less than the configuration parameter KMeans.CONF_CRIT_FUN_TERMINATION_VALUE

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
EuclideanDistanceCriterionFunction()

Method Summary

Modifier and Type	Method and Description
void	addClusterMember(RecordInfo member, double[] memberPoint) Adds the data and point of an individual cluster member.
void	beforeClusterCenterUpdated(int clusterId, double[] clusterCenter, double critFunValue, long memberCount) Sets the current cluster and its state before the cluster point is updated.
void	clusterCenterUpdated(double[] clusterCenter) Sets the updated cluster center point
double	getCriterionFunctionValue() Gets the new criterion function value calculated using the updated cluster center point
boolean	isClusterConverging() Tell whether the criterion function is converging for the current cluster
void	setup(Configuration conf) Perform initialization tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

EuclideanDistanceCriterionFunction

public EuclideanDistanceCriterionFunction()

Method Detail

addClusterMember

public void addClusterMember(RecordInfo member,
                             double[] memberPoint)

Description copied from interface: CriterionFunction

Adds the data and point of an individual cluster member. The implementer may need to copy the parameters values as the references could be reused.

Specified by:

addClusterMember in interface CriterionFunction

Parameters:

member - a cluster member as a RecordInfo instance

memberPoint - a cluster member point

beforeClusterCenterUpdated

public void beforeClusterCenterUpdated(int clusterId,
                                       double[] clusterCenter,
                                       double critFunValue,
                                       long memberCount)

Description copied from interface: CriterionFunction

Sets the current cluster and its state before the cluster point is updated.

Specified by:

beforeClusterCenterUpdated in interface CriterionFunction

Parameters:

clusterId - the cluster id

clusterCenter - the cluster center point before updated

critFunValue - the last criterion function value

memberCount - the number of cluster members

clusterCenterUpdated

public void clusterCenterUpdated(double[] clusterCenter)

Description copied from interface: CriterionFunction

Sets the updated cluster center point

Specified by:

clusterCenterUpdated in interface CriterionFunction

Parameters:

clusterCenter - the cluster center point ordinates

getCriterionFunctionValue

public double getCriterionFunctionValue()

Description copied from interface: CriterionFunction

Gets the new criterion function value calculated using the updated cluster center point

Specified by:

getCriterionFunctionValue in interface CriterionFunction

Returns:

the newest criterion function value

isClusterConverging

public boolean isClusterConverging()

Description copied from interface: CriterionFunction

Tell whether the criterion function is converging for the current cluster

Specified by:

isClusterConverging in interface CriterionFunction

Returns:

true if the function is converging for the current cluster

setup

public void setup(Configuration conf)

Description copied from interface: CriterionFunction

Perform initialization tasks. Called once per instance

Specified by:

setup in interface CriterionFunction

Parameters:

conf - the job configuration