uk.co.moons.control.neural

Class LimitNeuralFunction

java.lang.Object

uk.co.moons.control.neural.BaseNeuralFunction

uk.co.moons.control.neural.NeuralFunction

uk.co.moons.control.neural.LimitNeuralFunction

All Implemented Interfaces:

NeuralFunctionInterface

public class LimitNeuralFunction
extends NeuralFunction

Limit function

Output limited to between configured values.

The output is limited to a range between minimum and maximum values. If the input is outside of this range and the EnableInfinity parameter is true, then the output is infinity.

The configuration parameters to the function are as follows:

Min - a lower limit of the output value (type Double). Mandatory.
Max - an upper limit of the output value (type Double). Mandatory.
EnableInfinity - denotes setting infinity output when input is outside configured range (type Boolean).

Version:

1.0

Author:

Rupert Young

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enableinfinity
Double	max
Double	min

Fields inherited from class uk.co.moons.control.neural.BaseNeuralFunction

disabled, initial, last, linkAlphaComparator, links, linkslist, name, output, parameters, posindex, reset

Constructor Summary

Constructors

Constructor and Description
LimitNeuralFunction()
LimitNeuralFunction(List<Parameters> ps)

Method Summary

Methods

Modifier and Type	Method and Description
double	compute()
void	init()
void	verifyConfiguration()

Methods inherited from class uk.co.moons.control.neural.BaseNeuralFunction

clearParametersHashMap, close, deactivate, getConfigParameter, getDataString, getExternalControlFunction, getInitial, getName, getOutput, getParameter, getParameter, getParameter, getParameterBoolean, getParameterDouble, getParameterInt, getParameterName, getParameterObject, getParametersSet, getParametersSize, getParametersString, getParameterType, getPosindex, getTime, isDisabled, pause, post, setConfigLinks, setField, setInitial, setLink, setLinks, setName, setOutput, setParameter, setParameter, setPosindex, stop

Methods inherited from class java.lang.Object

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

Field Detail

max

public Double max

min

public Double min

enableinfinity

public boolean enableinfinity

Constructor Detail

LimitNeuralFunction

public LimitNeuralFunction()
                    throws Exception

Throws:

Exception

LimitNeuralFunction

public LimitNeuralFunction(List<Parameters> ps)
                    throws Exception

Throws:

Exception

Method Detail

verifyConfiguration

public void verifyConfiguration()
                         throws Exception

Overrides:

verifyConfiguration in class BaseNeuralFunction

Throws:

Exception

init

public void init()
          throws Exception

Overrides:

init in class BaseNeuralFunction

Throws:

Exception

compute

public double compute()

Specified by:

compute in interface NeuralFunctionInterface

Overrides:

compute in class NeuralFunction