org.ai_heuristic.functs.learn

Class FunctionCount

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionLearn

org.ai_heuristic.functs.learn.FunctionCount

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

public class FunctionCount
extends FunctionLearn

This function simply adds two objects together and returns the result. These do not have to be of type double, but the mathOperation function must be provided.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

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

Method Summary

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

FunctionCount

public FunctionCount()
              throws java.lang.Exception

Create a new instance of FunctionCount.

Throws:

java.lang.Exception - any error.

FunctionCount

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

Create a new instance of FunctionCount.

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 function simply adds the two count values together and returns the result.

Specified by:

evaluate in interface FunctionDef

Specified by:

evaluate in class FunctionSingle

Parameters:

dataset - a dataset with the two values to add together.

Returns:

the sum of the two values.

Throws:

java.lang.Exception - any error.

evaluate

public double evaluate(double value1,
                       double value2)
                throws java.lang.Exception

Return a value based on the function evaluation. This function simply adds the two count values together and returns the result.

Parameters:

value1 - the first value to add.

value2 - the second value to add.

Returns:

the sum of the two values.

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.