org.ai_heuristic.algo.cluster

Class CompleteLinkCluster

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.algo.AlgorithmCompare

org.ai_heuristic.algo.AlgorithmCompareList

org.ai_heuristic.algo.cluster.CompleteLinkCluster

All Implemented Interfaces:

FunctionDef

public class CompleteLinkCluster
extends AlgorithmCompareList

Implements the complete-link clustering algorithm. The returned distance is the maximum or furthest between any two elements in the existing clusters. A match still means a similarity score, but return the largest evaluated result.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.algo.AlgorithmCompareList

bestCluster, bestIndexes, dataset

Fields inherited from class org.ai_heuristic.algo.AlgorithmCompare

bestEval, evalMetric

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

Constructor and Description
CompleteLinkCluster(FunctionMetric thisEvalMetric) Create a new empty instance of CompleteLinkCluster.
CompleteLinkCluster(java.lang.String thisValueType, FunctionMetric thisEvalMetric) Create a new instance of CompleteLinkCluster.

Method Summary

Modifier and Type	Method and Description
ReplySet	evaluate(MetricDataset compareWith) Calculate the closest dataset from datasets to the parameter dataset.
protected void	initialise() Initialise the function values, setting the config parameters or other.

Methods inherited from class org.ai_heuristic.algo.AlgorithmCompareList

distance, getBestCluster, getBestIndexes, getDataset, resetValues, setDataset

Methods inherited from class org.ai_heuristic.algo.AlgorithmCompare

getBestEvaluation

Methods inherited from class org.ai_heuristic.functs.Function

checkValueType, createFunction, createFunction, createFunction, getConfigParams, innerObject, isLegalNumber, setConfigParams, setEvaluator, setValueType

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteLinkCluster

public CompleteLinkCluster(FunctionMetric thisEvalMetric)
                    throws java.lang.Exception

Create a new empty instance of CompleteLinkCluster. Set the local dataset later.

Parameters:

thisEvalMetric - the distance function.

Throws:

java.lang.Exception - any error.

CompleteLinkCluster

public CompleteLinkCluster(java.lang.String thisValueType,
                           FunctionMetric thisEvalMetric)
                    throws java.lang.Exception

Create a new instance of CompleteLinkCluster.

Parameters:

thisValueType - the type of object being evaluated.

thisEvalMetric - the distance function.

Throws:

java.lang.Exception - any error.

Method Detail

initialise

protected void initialise()

Initialise the function values, setting the config parameters or other.

Overrides:

initialise in class AlgorithmCompareList

evaluate

public ReplySet evaluate(MetricDataset compareWith)
                  throws java.lang.Exception

Calculate the closest dataset from datasets to the parameter dataset. If there is no match (evaluation of 0 or less) then a negative number is returned.

Specified by:

evaluate in interface FunctionDef

Overrides:

evaluate in class Function

Parameters:

compareWith - stores a list of datasets to compare with, as specified above. Each values in the compareWith list is a MetricValue and its data object should be another dataset. If it is not, then a dataset is created with the object as a single value.

Returns:

the index of the dataset from the datasets list that is measured to be closest to this one. You can use ((Integer)ReplySet.getValue()).intValue() to retrieve the index. Indexes for the closest points in the two datasets can be retrieved from the getBestIndexes method.

Throws:

java.lang.Exception - any error.