org.ai_heuristic.functs.activate

Class FunctionLinearPlus

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionActivate

org.ai_heuristic.functs.activate.FunctionLinearPlus

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

public class FunctionLinearPlus
extends FunctionActivate

This function returns a linear value calculated by y = (a * x) + b, where a and b are parameters of type double. They should be added as config parameters, with the key values of AiHeuristicConst.LPFA and LPFB. Only the first dataset value is retrieved and measured. This is added as part of the som package, copied from the related source code.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
double	evaluate(double value, double a, double b) Return a value based on the function evaluation.
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 mathOperation evaluator mathCompare.

Methods inherited from class org.ai_heuristic.functs.FunctionSingle

evaluateSingle

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

FunctionLinearPlus

public FunctionLinearPlus()
                   throws java.lang.Exception

Create a new instance of FunctionLinearPlus.

Throws:

java.lang.Exception - any error.

FunctionLinearPlus

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

Create a new instance of FunctionLinearPlus.

Parameters:

thisValueType - the type of object being evaluated.

thisConfig - list of initialisation function-specific parameters.

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 function multiplies and adds depending on what config parameters have been set.

Specified by:

evaluate in interface FunctionDef

Specified by:

evaluate in class FunctionSingle

Parameters:

dataset - a dataset with the value to evaluate.

Returns:

the activation evaluation.

Throws:

java.lang.Exception - any error.

evaluate

public double evaluate(double value,
                       double a,
                       double b)
                throws java.lang.Exception

Return a value based on the function evaluation. This function multiplies and adds depending on the input parameters.

Parameters:

value - the value to evaluate.

a - the multiplication param. If 0 then not used.

b - the additive param. Always added.

Returns:

the activation evaluation.

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 mathOperation evaluator mathCompare.

Returns:

a new instance of this function.

Throws:

java.lang.Exception - any error.