oracle.spatial.hadoop.vector.cluster.kmeans

Class SquaredErrorCriterionFunction

java.lang.Object

oracle.spatial.hadoop.vector.cluster.kmeans.SquaredErrorCriterionFunction

All Implemented Interfaces:

CriterionFunction

public class SquaredErrorCriterionFunction
extends java.lang.Object
implements CriterionFunction

CriterionFunction implementation that uses a squared error criterion function.

Constructor Summary

Constructors

Constructor and Description
SquaredErrorCriterionFunction()

Method Summary

Methods

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(org.apache.hadoop.conf.Configuration conf) Perform initialization tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

SquaredErrorCriterionFunction

public SquaredErrorCriterionFunction()

Method Detail

setup

public void setup(org.apache.hadoop.conf.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

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

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

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