org.ai_heuristic.functs.activate

Class FunctionTanH

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionActivate

org.ai_heuristic.functs.activate.FunctionTanH

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

public class FunctionTanH
extends FunctionActivate

This function returns the tanh value as defined by ((e^2x - 1) / (e^2x + 1)) where x is the input value and probably of type double.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

Constructor and Description
FunctionTanH() Create a new instance of FunctionTanH.
FunctionTanH(java.lang.String thisValueType) Create a new instance of FunctionTanH.

Method Summary

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

FunctionTanH

public FunctionTanH()
             throws java.lang.Exception

Create a new instance of FunctionTanH.

Throws:

java.lang.Exception - any error.

FunctionTanH

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

Create a new instance of FunctionTanH.

Parameters:

thisValueType - the type of object being evaluated.

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 is the TanH value.

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

Return a value based on the function evaluation. This is the TanH value.

Parameters:

value - the value to evaluate.

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.