org.ai_heuristic.functs.test

Class SimpleFunction

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.test.SimpleFunction

All Implemented Interfaces:

FunctionDef

public class SimpleFunction
extends Function

This class is one example of a simple numerical function, to be used for testing. The evaluation adds a random value to the parameter passed in and then divides this summation by the random value again, to produce a floating point result. This will always return the same result for the same parameter object and is intended simply to produce some arbitrary test value that is consistent.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

Constructor and Description
SimpleFunction() Create a new instance of SimpleFunction.
SimpleFunction(java.lang.String thisValueType, java.util.HashMap thisConfig) Create a new instance of SimpleFunction.
SimpleFunction(java.lang.String thisValueType, int minValue, int maxValue) Create a new instance of SimpleFunction.

Method Summary

Modifier and Type	Method and Description
ReplySet	evaluate(MetricDataset dataset) Return a value based on the function evaluation.
protected void	initialise() Initialise the function values, setting the config parameters or other.
Function	newInstance() Create and return a new instance of the function, initialised with this function's value type valueType and math evaluator mathCompare.

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

SimpleFunction

public SimpleFunction()
               throws java.lang.Exception

Create a new instance of SimpleFunction.

Throws:

java.lang.Exception - any error.

SimpleFunction

public SimpleFunction(java.lang.String thisValueType,
                      int minValue,
                      int maxValue)
               throws java.lang.Exception

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

Parameters:

thisValueType - type the type of object being evaluated.

minValue - the minimum value for the parameter.

maxValue - the maximum value for the parameter.

Throws:

java.lang.Exception - any error.

SimpleFunction

public SimpleFunction(java.lang.String thisValueType,
                      java.util.HashMap thisConfig)
               throws java.lang.Exception

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

Parameters:

thisValueType - type the type of object being evaluated.

thisConfig - configuration parameters. This should include AiHeuristicConst.MAX and MIN values.

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.

evaluate

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

Return a value based on the function evaluation. This implementation only selects the object value for this solution, adds a random value to it and then divides by the random value to make a new evaluation. There are no comparisons with other datasets.

Specified by:

evaluate in interface FunctionDef

Overrides:

evaluate in class Function

Parameters:

dataset - the value to pass through the function.

Returns:

the processed value, of type Double.

Throws:

java.lang.Exception - any error.

newInstance

public Function newInstance()
                     throws java.lang.Exception

Create and return a new instance of the function, initialised with this function's value type valueType and math evaluator mathCompare.

Returns:

a new instance of this function.

Throws:

java.lang.Exception - any error.