org.ai_heuristic.algo

Class AlgorithmCompareList

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.algo.AlgorithmCompare

org.ai_heuristic.algo.AlgorithmCompareList

All Implemented Interfaces:

FunctionDef

Direct Known Subclasses:

CompleteLinkCluster, SingleLinkCluster

public abstract class AlgorithmCompareList
extends AlgorithmCompare

Base class for algorithms that perform a direct comparison between own dataset and a set of input datasets. Note that own dataset is static and not changed. It would typically be added as part of the initialisation process, or part of a set of datasets to compare with each other.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bestCluster Index position of the best or closest dataset to this one, for a list of clusters
protected int[]	bestIndexes Index positions of the currently best values from this dataset and the best one compared with.
protected MetricDataset	dataset The dataset to compare with

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
AlgorithmCompareList() Create a new instance of AlgorithmCompareList.
AlgorithmCompareList(java.lang.String thisValueType) Create a new instance of AlgorithmCompareList.
AlgorithmCompareList(java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig) Create a new instance of AlgorithmCompareList.
AlgorithmCompareList(java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig, FunctionMetric thisEvalMetric) Create a new empty instance of AlgorithmCompareList.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Double	distance(MetricDataset datasetWith) Measure the distance between the dataset parameter and the dataset of this algorithm.
int	getBestCluster() Get the index of the best dataset from a list compared with.
int[]	getBestIndexes() Get the indexes of the closest comparisons between this dataset and the best one.
MetricDataset	getDataset() Get the dataset this algorithm uses as the reference point.
protected void	initialise() Initialise the function values, setting the config parameters or other.
void	resetValues() Reset the evaluation results for a new test scenario.
void	setDataset(MetricDataset thisDataset) Set the dataset this algorithm uses as the reference point.

Methods inherited from class org.ai_heuristic.algo.AlgorithmCompare

getBestEvaluation

Methods inherited from class org.ai_heuristic.functs.Function

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

Methods inherited from class java.lang.Object

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

Field Detail

bestCluster

protected int bestCluster

Index position of the best or closest dataset to this one, for a list of clusters

bestIndexes

protected int[] bestIndexes

Index positions of the currently best values from this dataset and the best one compared with. Of size 2, where the first entry is for the data point in this dataset and the second entry is for the data point in the dataset evaluated as closest to this one.

dataset

protected MetricDataset dataset

The dataset to compare with

Constructor Detail

AlgorithmCompareList

public AlgorithmCompareList()
                     throws java.lang.Exception

Create a new instance of AlgorithmCompareList.

Throws:

java.lang.Exception - any error.

AlgorithmCompareList

public AlgorithmCompareList(java.lang.String thisValueType)
                     throws java.lang.Exception

Create a new instance of AlgorithmCompareList.

Parameters:

thisValueType - the type of object being evaluated.

Throws:

java.lang.Exception - any error.

AlgorithmCompareList

public AlgorithmCompareList(java.lang.String thisValueType,
                            java.util.HashMap<java.lang.String,?> thisConfig)
                     throws java.lang.Exception

Create a new instance of AlgorithmCompareList.

Parameters:

thisValueType - the type of object being evaluated. Can be null if set later or not used.

thisConfig - list of initialisation function-specific parameters.

Throws:

java.lang.Exception - any error.

AlgorithmCompareList

public AlgorithmCompareList(java.lang.String thisValueType,
                            java.util.HashMap<java.lang.String,?> thisConfig,
                            FunctionMetric thisEvalMetric)
                     throws java.lang.Exception

Create a new empty instance of AlgorithmCompareList.

Parameters:

thisValueType - the type of object being evaluated. Can be null if set later or not used.

thisConfig - list of initialisation function-specific parameters.

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 AlgorithmCompare

resetValues

public void resetValues()

Reset the evaluation results for a new test scenario.

Overrides:

resetValues in class AlgorithmCompare

distance

protected java.lang.Double distance(MetricDataset datasetWith)
                             throws java.lang.Exception

Measure the distance between the dataset parameter and the dataset of this algorithm. For a single link, this is the closest distance between any two points, one from either dataset.

Parameters:

datasetWith - the dataset to compare with, as specified above.

Returns:

the closest distance between any two data points.

Throws:

java.lang.Exception - any error.

setDataset

public void setDataset(MetricDataset thisDataset)

Set the dataset this algorithm uses as the reference point.

Parameters:

thisDataset - the dataset to compare with.

getDataset

public MetricDataset getDataset()

Get the dataset this algorithm uses as the reference point.

Returns:

the value of dataset.

getBestCluster

public int getBestCluster()

Get the index of the best dataset from a list compared with.

Returns:

the value of bestCluster.

getBestIndexes

public int[] getBestIndexes()

Get the indexes of the closest comparisons between this dataset and the best one. Of size 2, where the first entry is for the data point in this dataset and the second entry is for the data point in the dataset evaluated as closest to this one.

Returns:

the value of bestIndexes.