org.simbrain.network.neuron_update_rules

Class DecayRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.neuron_update_rules.DecayRule

All Implemented Interfaces:

BoundedUpdateRule, ClippableUpdateRule, NoisyUpdateRule

public class DecayRule
extends NeuronUpdateRule
implements BoundedUpdateRule, ClippableUpdateRule, NoisyUpdateRule

DecayNeuron implements various forms of standard decay.

Nested Class Summary

Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule

NeuronUpdateRule.InputType

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABSOLUTE Absolute.
static int	RELATIVE Relative.

Fields inherited from class org.simbrain.network.core.NeuronUpdateRule

DEFAULT_INCREMENT, increment, inputType

Constructor Summary

Constructors

Constructor and Description
DecayRule()

Method Summary

Modifier and Type	Method and Description
double	clip(double val) Clip the current activation.
void	contextualDecrement(Neuron n) Decrement a neuron by increment, respecting neuron specific constraints.
void	contextualIncrement(Neuron n) Increment a neuron by increment, respecting neuron specific constraints.
DecayRule	deepCopy() Returns a deep copy of the update rule.
boolean	getAddNoise() Return true if add noise is turned on.
double	getBaseLine()
double	getDecayAmount()
double	getDecayFraction()
java.lang.String	getDescription() Returns a brief description of this update rule.
double	getLowerBound() Returns the lower bound.
Randomizer	getNoiseGenerator() Return the noise generator.
int	getRelAbs()
Network.TimeType	getTimeType() Returns the type of time update (discrete or continuous) associated with this neuron.
double	getUpperBound() Returns the upper bound.
boolean	isClipped() Is clipping turned on or not.
void	setAddNoise(boolean addNoise) Set whether noise should be used.
void	setBaseLine(double baseLine)
void	setClipped(boolean clipping) Turn clipping on and off.
void	setDecayAmount(double decayAmount)
void	setDecayFraction(double decayFraction)
void	setLowerBound(double floor) Sets the lower bound of this neuron update rule's activation.
void	setNoiseGenerator(Randomizer noiseGenerator) Set the noise generator.
void	setRelAbs(int relAbs)
void	setUpperBound(double ceiling) Sets the upper bound of this neuron update rule's activation.
void	update(Neuron neuron) Apply the update rule.

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule

clear, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, getToolTipText, incrementActivation, isSkipsSynapticUpdates, isSpikingNeuron, setIncrement, setInputType

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE

public static final int RELATIVE

Relative.

See Also:

Constant Field Values

ABSOLUTE

public static final int ABSOLUTE

Absolute.

See Also:

Constant Field Values

Constructor Detail

DecayRule

public DecayRule()

Method Detail

getTimeType

public Network.TimeType getTimeType()

Description copied from class: NeuronUpdateRule

Returns the type of time update (discrete or continuous) associated with this neuron.

Specified by:

getTimeType in class NeuronUpdateRule

Returns:

Time type.

deepCopy

public DecayRule deepCopy()

Returns a deep copy of the update rule.

Specified by:

deepCopy in class NeuronUpdateRule

Returns:

update

public void update(Neuron neuron)

Apply the update rule.

Specified by:

update in class NeuronUpdateRule

Parameters:

neuron -

clip

public double clip(double val)

Clip the current activation.

Specified by:

clip in interface ClippableUpdateRule

Parameters:

val - the value to clip

Returns:

the clipped value

contextualIncrement

public void contextualIncrement(Neuron n)

Increment a neuron by increment, respecting neuron specific constraints. Intended to be overriden.

Overrides:

contextualIncrement in class NeuronUpdateRule

Parameters:

n - neuron to be incremented

contextualDecrement

public void contextualDecrement(Neuron n)

Decrement a neuron by increment, respecting neuron specific constraints. Intended to be overriden.

Overrides:

contextualDecrement in class NeuronUpdateRule

Parameters:

n - neuron

getDecayAmount

public double getDecayAmount()

Returns:

Returns the decayAmount.

setDecayAmount

public void setDecayAmount(double decayAmount)

Parameters:

decayAmount - The decayAmount to set.

getDecayFraction

public double getDecayFraction()

Returns:

Returns the dedayPercentage.

setDecayFraction

public void setDecayFraction(double decayFraction)

Parameters:

decayFraction - The decayFraction to set.

getRelAbs

public int getRelAbs()

Returns:

Returns the relAbs.

setRelAbs

public void setRelAbs(int relAbs)

Parameters:

relAbs - The relAbs to set.

getAddNoise

public boolean getAddNoise()

Description copied from interface: NoisyUpdateRule

Return true if add noise is turned on.

Specified by:

getAddNoise in interface NoisyUpdateRule

Returns:

Returns the addNoise.

setAddNoise

public void setAddNoise(boolean addNoise)

Description copied from interface: NoisyUpdateRule

Set whether noise should be used.

Specified by:

setAddNoise in interface NoisyUpdateRule

Parameters:

addNoise - The addNoise to set.

getNoiseGenerator

public Randomizer getNoiseGenerator()

Description copied from interface: NoisyUpdateRule

Return the noise generator.

Specified by:

getNoiseGenerator in interface NoisyUpdateRule

Returns:

Returns the noiseGenerator.

setNoiseGenerator

public void setNoiseGenerator(Randomizer noiseGenerator)

Description copied from interface: NoisyUpdateRule

Set the noise generator.

Specified by:

setNoiseGenerator in interface NoisyUpdateRule

Parameters:

noiseGenerator - The noiseGenerator to set.

getBaseLine

public double getBaseLine()

Returns:

Returns the baseLine.

setBaseLine

public void setBaseLine(double baseLine)

Parameters:

baseLine - The baseLine to set.

getDescription

public java.lang.String getDescription()

Description copied from class: NeuronUpdateRule

Returns a brief description of this update rule. Used in combo boxes in the GUI.

Specified by:

getDescription in class NeuronUpdateRule

Returns:

the description.

getUpperBound

public double getUpperBound()

Description copied from interface: BoundedUpdateRule

Returns the upper bound.

Specified by:

getUpperBound in interface BoundedUpdateRule

Returns:

the upper boud

getLowerBound

public double getLowerBound()

Description copied from interface: BoundedUpdateRule

Returns the lower bound.

Specified by:

getLowerBound in interface BoundedUpdateRule

Returns:

the lower bound

setUpperBound

public void setUpperBound(double ceiling)

Description copied from interface: BoundedUpdateRule

Sets the upper bound of this neuron update rule's activation.

Specified by:

setUpperBound in interface BoundedUpdateRule

Parameters:

ceiling - the upper bound

setLowerBound

public void setLowerBound(double floor)

Description copied from interface: BoundedUpdateRule

Sets the lower bound of this neuron update rule's activation.

Specified by:

setLowerBound in interface BoundedUpdateRule

Parameters:

floor - the lower bound

isClipped

public boolean isClipped()

Description copied from interface: ClippableUpdateRule

Is clipping turned on or not.

Specified by:

isClipped in interface ClippableUpdateRule

Returns:

true if clipping is on; false if it's turned off

setClipped

public void setClipped(boolean clipping)

Description copied from interface: ClippableUpdateRule

Turn clipping on and off.

Specified by:

setClipped in interface ClippableUpdateRule

Parameters:

clipping - true if clipping should be on; false otherwise