org.ai_heuristic.functs

Class FunctionSingle

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

Direct Known Subclasses:

FunctionActivate, FunctionLearn

public abstract class FunctionSingle
extends Function
implements FunctionSingleDef

This is the base class for any of the evaluation metrics or functions that try to perform an evaluation over a sigle MetricDataset dataset only.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract ReplySet	evaluate(MetricDataset dataset) Return a value based on the function evaluation.
protected ReplySet	evaluateSingle(MetricDataset dataset) Return a value based on the function evaluation.

Methods inherited from class org.ai_heuristic.functs.Function

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ai_heuristic.def.FunctionSingleDef

newInstance

Constructor Detail

FunctionSingle

public FunctionSingle()
               throws java.lang.Exception

Create a new instance of FunctionSingle. The eval evaluator is set to SimpleMathCompare. To change this, use the setEvaluator method.

Throws:

java.lang.Exception - any error.

FunctionSingle

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

Create a new instance of FunctionSingle. The eval evaluator is set to SimpleMathCompare. To change this, use the setEvaluator method.

Parameters:

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

Throws:

java.lang.Exception - any error.

FunctionSingle

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

Create a new instance of FunctionSingle. The eval evaluator is set to SimpleMathCompare. To change this, use the setEvaluator method.

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.

Method Detail

evaluate

public abstract ReplySet evaluate(MetricDataset dataset)
                           throws java.lang.Exception

Return a value based on the function evaluation. This function simply returns the first value in the dataset as is, without any changes.

Specified by:

evaluate in interface FunctionDef

Overrides:

evaluate in class Function

Parameters:

dataset - a dataset with the value to evaluate.

Returns:

the first value in the dataset.

Throws:

java.lang.Exception - any error.

evaluateSingle

protected ReplySet evaluateSingle(MetricDataset dataset)
                           throws java.lang.Exception

Return a value based on the function evaluation. This function simply returns the first value in the dataset as is, without any changes.

Parameters:

dataset - a dataset with the value to evaluate.

Returns:

the first value in the dataset.

Throws:

java.lang.Exception - any error.