org.ai_heuristic.functs.learn

Class FunctionHyperbolicFactor

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionLearn

org.ai_heuristic.functs.learn.FunctionHyperbolicFactor

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

public class FunctionHyperbolicFactor
extends FunctionLearn

This function returns the first value in the dataset, changed by c /(c2 + k). To use it, you need to pass the value and also the AiHeuristicConst.HFC and HFC2 parameter constants, of type double. The value itself should also be a basic number type. This has been added as part of the som package, with the intention that it can be used more generally.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

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

Method Summary

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

FunctionHyperbolicFactor

public FunctionHyperbolicFactor()
                         throws java.lang.Exception

Create a new instance of FunctionHyperbolicFactor.

Throws:

java.lang.Exception - any error.

FunctionHyperbolicFactor

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

Create a new instance of FunctionHyperbolicFactor.

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 returns a hyperbolic factor evaluation of the value.

Specified by:

evaluate in interface FunctionDef

Specified by:

evaluate in class FunctionSingle

Parameters:

dataset - a dataset with the value to evaluate.

Returns:

the first value in the dataset.

Throws:

java.lang.Exception - any error.

evaluate

public double evaluate(double value,
                       double hc,
                       double hc2)
                throws java.lang.Exception

Return a value based on the function evaluation. This function returns a hyperbolic factor evaluation of the value.

Parameters:

value - the value to evaluate.

hc - the first constant.

hc2 - the second constant.

Returns:

the first value in the dataset.

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.