uk.co.moons.control.neural

Class ThresholdNeuralFunction

java.lang.Object

uk.co.moons.control.neural.BaseNeuralFunction

uk.co.moons.control.neural.NeuralFunction

uk.co.moons.control.neural.ThresholdNeuralFunction

All Implemented Interfaces:

NeuralFunctionInterface

public class ThresholdNeuralFunction
extends NeuralFunction

Threshold function.

Output limited to by a threshold value.

If the input is greater than the threshold then input value is returned, otherwise the threshold value (with same sign as the input) is returned. If the Alternate parameter is set then the value of that is returned.

Or, if the LessThan parameter, is set then opposite logic is applied.

The configuration parameters to the function are as follows:

Threshold - the threshold value (type Double). Mandatory.
Alternate - an alternate output value (type Double).
LessThan - true or false (type Boolean).

Version:

1.0

Author:

Rupert Young

Field Summary

Fields

Modifier and Type	Field and Description
Double	alternate
boolean	lessthan
Double	threshold

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
ThresholdNeuralFunction(double t)
ThresholdNeuralFunction(int t)
ThresholdNeuralFunction(List<Parameters> ps)

Method Summary

Methods

Modifier and Type	Method and Description
double	compute()

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, init, isDisabled, pause, post, setConfigLinks, setField, setInitial, setLink, setLinks, setName, setOutput, setParameter, setParameter, setPosindex, stop, verifyConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

threshold

public Double threshold

alternate

public Double alternate

lessthan

public boolean lessthan

Constructor Detail

ThresholdNeuralFunction

public ThresholdNeuralFunction(double t)

ThresholdNeuralFunction

public ThresholdNeuralFunction(int t)

ThresholdNeuralFunction

public ThresholdNeuralFunction(List<Parameters> ps)
                        throws Exception

Throws:

Exception

Method Detail

compute

public double compute()

Specified by:

compute in interface NeuralFunctionInterface

Overrides:

compute in class NeuralFunction