uk.co.moons.control.neural

Class ProportionalIntegrationNeuralFunction

java.lang.Object

uk.co.moons.control.neural.BaseNeuralFunction

uk.co.moons.control.neural.NeuralFunction

uk.co.moons.control.neural.ProportionalIntegrationNeuralFunction

All Implemented Interfaces:

NeuralFunctionInterface

public class ProportionalIntegrationNeuralFunction
extends NeuralFunction

A proportional integration function

A function that adds a proportion of an input value to itself.

The basic function equation is output += gain * input;.

The configuration parameters to the function are as follows:
Gain - the proportion value, which may be -x to +x (type Double). Mandatory. Min - a lower limit of the output value (type Double).
Max - an upper limit of the output value (type Double).

Version:

1.0

Author:

Rupert Young

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	enableinfinity
Double	gain
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
ProportionalIntegrationNeuralFunction(int g)
ProportionalIntegrationNeuralFunction(List<Parameters> ps)

Method Summary

Methods

Modifier and Type	Method and Description
double	compute()
double	getParameter()
void	init()
void	setParameter(double par)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

gain

public Double gain

min

public Double min

max

public Double max

enableinfinity

public Boolean enableinfinity

Constructor Detail

ProportionalIntegrationNeuralFunction

public ProportionalIntegrationNeuralFunction(int g)

Parameters:

g -

ProportionalIntegrationNeuralFunction

public ProportionalIntegrationNeuralFunction(List<Parameters> ps)
                                      throws Exception

Parameters:

ps -

Throws:

Exception

Method Detail

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

Returns:

getParameter

public double getParameter()

Specified by:

getParameter in interface NeuralFunctionInterface

Overrides:

getParameter in class BaseNeuralFunction

setParameter

public void setParameter(double par)

Specified by:

setParameter in interface NeuralFunctionInterface

Overrides:

setParameter in class BaseNeuralFunction