org.ai_heuristic.functs

Class FunctionLearn

java.lang.Object

org.ai_heuristic.functs.Function

org.ai_heuristic.functs.FunctionSingle

org.ai_heuristic.functs.FunctionLearn

All Implemented Interfaces:

FunctionDef, FunctionSingleDef

Direct Known Subclasses:

FunctionConstantFactor, FunctionCount, FunctionExponentialFactor, FunctionGaussFactor, FunctionHyperbolicFactor

public abstract class FunctionLearn
extends FunctionSingle

This is the base class for any of the evaluation metrics or functions that try to learn a best value over time. It might be used with the learning algorithms.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.functs.Function

config, mathCompare, valueType

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class org.ai_heuristic.functs.FunctionSingle

evaluate, evaluateSingle

Methods inherited from class org.ai_heuristic.functs.Function

checkValueType, createFunction, createFunction, createFunction, getConfigParams, initialise, innerObject, isLegalNumber, setConfigParams, setEvaluator, setValueType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ai_heuristic.def.FunctionSingleDef

newInstance

Constructor Detail

FunctionLearn

public FunctionLearn()
              throws java.lang.Exception

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

Throws:

java.lang.Exception - any error.

FunctionLearn

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

Create a new instance of FunctionLearn. The eval 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.

FunctionLearn

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

Create a new instance of FunctionLearn. The eval 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.