org.ai_heuristic.algo

Class AlgorithmCompare

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.algo.AlgorithmCompare

All Implemented Interfaces:

FunctionDef

Direct Known Subclasses:

AlgorithmCompareList, AlgorithmCompareTree

public abstract class AlgorithmCompare
extends Function

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

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	bestEval The best resulting evaluation.
protected FunctionMetric	evalMetric The metric to calculate the distance with.

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

Constructor and Description
AlgorithmCompare() Create a new instance of AlgorithmCompare.
AlgorithmCompare(java.lang.String thisValueType) Create a new instance of AlgorithmCompare.
AlgorithmCompare(java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig) Create a new instance of AlgorithmCompare.
AlgorithmCompare(java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig, FunctionMetric thisEvalMetric) Create a new empty instance of AlgorithmCompare.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getBestEvaluation() Get the current best evaluation.
protected void	initialise() Initialise the function values, setting the config parameters or other.
void	resetValues() Reset the evaluation results for a new test scenario.

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

bestEval

protected java.lang.Object bestEval

The best resulting evaluation. The type depends on the data value type.

evalMetric

protected FunctionMetric evalMetric

The metric to calculate the distance with.

Constructor Detail

AlgorithmCompare

public AlgorithmCompare()
                 throws java.lang.Exception

Create a new instance of AlgorithmCompare.

Throws:

java.lang.Exception - any error.

AlgorithmCompare

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

Create a new instance of AlgorithmCompare.

Parameters:

thisValueType - the type of object being evaluated.

Throws:

java.lang.Exception - any error.

AlgorithmCompare

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

Create a new instance of AlgorithmCompare.

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.

AlgorithmCompare

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

Create a new empty instance of AlgorithmCompare.

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()
                   throws java.lang.Exception

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

Specified by:

initialise in class Function

Throws:

java.lang.Exception - any error.

resetValues

public void resetValues()

Reset the evaluation results for a new test scenario.

getBestEvaluation

public java.lang.Object getBestEvaluation()

Get the current best evaluation.

Returns:

the value of bestEval.