org.ai_heuristic.functs

Class Function

java.lang.Object

org.ai_heuristic.functs.Function

All Implemented Interfaces:

FunctionDef

Direct Known Subclasses:

AlgorithmCompare, AlgorithmLearn, Entropy, FunctionMetric, FunctionSingle, InformationGain, SimpleFunction, VarGain

public abstract class Function
extends java.lang.Object
implements FunctionDef

This is the base class for adding a function of any type. The function instance must extend FunctionSingle if it evaluates a single dataset, or FunctionMetric if it compares two datasets. If the function instance does not extend either of these it may not be recognised.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,?>	config A list of configuration parameters, as key-value pairs.
protected EvaluateMathDef	mathCompare The evaluation service
protected java.lang.String	valueType Type of object being evaluated

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	checkValueType(MetricDataset md) If the value type is null, then set it to the data object type in the dataset.
static Function	createFunction(java.lang.String functionType) Create a new instance of Function.
static Function	createFunction(java.lang.String functionType, java.lang.String thisValueType) Create a new instance of Function.
static Function	createFunction(java.lang.String functionType, java.lang.String thisValueType, java.util.HashMap<java.lang.String,?> thisConfig) Create a new instance of Function.
ReplySet	evaluate(MetricDataset dataset) Return a value based on the function evaluation.
java.util.HashMap<java.lang.String,?>	getConfigParams() Get the additional config parameters list.
protected abstract void	initialise() Initialise the function values, setting the config parameters or other.
protected java.lang.Object	innerObject(java.lang.Object metricValue) Convert the data object to return the nested value if of type MetricValue.
static boolean	isLegalNumber(java.lang.Object number) Return true if the value is a legal number, for instance, not infinite or NaN.
void	setConfigParams(java.util.HashMap<java.lang.String,?> configParams) Set the additional config parameters list.
void	setEvaluator(EvaluateMathDef thisEval) Set the evaluator used to make the mathematical comparisons.
void	setValueType(java.lang.String thisValueType) Set the value type for the object to be evaluated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valueType

protected java.lang.String valueType

Type of object being evaluated

mathCompare

protected EvaluateMathDef mathCompare

The evaluation service

config

protected java.util.HashMap<java.lang.String,?> config

A list of configuration parameters, as key-value pairs. This can be any type of information.

Constructor Detail

Function

public Function()
         throws java.lang.Exception

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

Throws:

java.lang.Exception - any error.

Function

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

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

Parameters:

thisValueType - the type of object being evaluated. Can be null if set later or not used.

Throws:

java.lang.Exception - any error.

Function

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

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

Parameters:

thisValueType - the type of object being evaluated. Can be null if set later or not used.

thisConfig - list of initialisation function-specific parameters.

Throws:

java.lang.Exception - any error.

Method Detail

initialise

protected abstract void initialise()
                            throws java.lang.Exception

Initialise the function values, setting the config parameters or other. Call from the derived class constructor and add an empty method if no settings need to be initialised.

Throws:

java.lang.Exception - any error.

evaluate

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

Return a value based on the function evaluation. If the function instance is a FunctionSingle, then the dataset must be of type MetricDataset. If the function instance is a FunctionMetric, then the dataset must be of type MetricCompare.

Specified by:

evaluate in interface FunctionDef

Parameters:

dataset - a dataset with the value to evaluate.

Returns:

the first value in the dataset.

Throws:

java.lang.Exception - any error.

innerObject

protected java.lang.Object innerObject(java.lang.Object metricValue)

Convert the data object to return the nested value if of type MetricValue.

Parameters:

metricValue - the metric value. could be a raw value or a MetricValue object, for example.

Returns:

the raw data value object.

checkValueType

protected void checkValueType(MetricDataset md)

If the value type is null, then set it to the data object type in the dataset.

Parameters:

md - the metric dataset to use.

setValueType

public void setValueType(java.lang.String thisValueType)

Set the value type for the object to be evaluated.

Parameters:

thisValueType - the value of valueType.

setEvaluator

public void setEvaluator(EvaluateMathDef thisEval)

Set the evaluator used to make the mathematical comparisons.

Parameters:

thisEval - the value of mathCompare.

setConfigParams

public void setConfigParams(java.util.HashMap<java.lang.String,?> configParams)
                     throws java.lang.Exception

Set the additional config parameters list. If setting the function values individually, then this will use the config list to re-initialise the function values, with a call to initialise from here.

Parameters:

configParams - a copy of this is assigned to config.

Throws:

java.lang.Exception - any error.

getConfigParams

public java.util.HashMap<java.lang.String,?> getConfigParams()

Get the additional config parameters list.

Returns:

the value of config.

isLegalNumber

public static boolean isLegalNumber(java.lang.Object number)

Return true if the value is a legal number, for instance, not infinite or NaN.

Parameters:

number - the floating point number to check.

Returns:

true if legal, false otherwise.

createFunction

public static Function createFunction(java.lang.String functionType)
                               throws java.lang.Exception

Create a new instance of Function.

Parameters:

functionType - the type of function to create. These are listed in AiHeuristicConst.

Returns:

the created function.

Throws:

java.lang.Exception - any error.

createFunction

public static Function createFunction(java.lang.String functionType,
                                      java.lang.String thisValueType)
                               throws java.lang.Exception

Create a new instance of Function. If this this set of parameters does not work, the call gets passed to the createFunction call that does not require parameters.

Parameters:

functionType - the type of function to create. These are listed in AiHeuristicConst.

thisValueType - the type of object being evaluated. Can be null if set later or not used.

Returns:

the created function.

Throws:

java.lang.Exception - any error.

createFunction

public static Function createFunction(java.lang.String functionType,
                                      java.lang.String thisValueType,
                                      java.util.HashMap<java.lang.String,?> thisConfig)
                               throws java.lang.Exception

Create a new instance of Function. If this this set of parameters does not work, the call gets passed to the createFunction call that only requires thisValueType.

Parameters:

functionType - the type of function to create. These are listed in AiHeuristicConst.

thisValueType - the type of object being evaluated. Can be null if set later or not used.

thisConfig - list of initialisation function-specific parameters.

Returns:

the created function.

Throws:

java.lang.Exception - any error.