org.ai_heuristic.functs.activate

Class FunctionHardLimit

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionActivate

org.ai_heuristic.functs.activate.FunctionHardLimit

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

public class FunctionHardLimit
extends FunctionActivate

This function returns 1.0 of the value is larger than a threshold and 0.0 otherwise. The threshold should be added as a config parameter, with the key value AiHeuristicConst.HLT. 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
FunctionHardLimit() Create a new instance of FunctionHardLimit.
FunctionHardLimit(java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig) Create a new instance of FunctionHardLimit.

Method Summary

Modifier and Type	Method and Description
double	evaluate(double value, double threshold) 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 math 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

FunctionHardLimit

public FunctionHardLimit()
                  throws java.lang.Exception

Create a new instance of FunctionHardLimit.

Throws:

java.lang.Exception - any error.

FunctionHardLimit

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

Create a new instance of FunctionHardLimit.

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.

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

Return a value based on the function evaluation.

Parameters:

value - the value to evaluate.

threshold - the threshold for the function activation.

Returns:

1.0 if larger than the threshold, 0.0 otherwise.

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.