public class IACRule extends NeuronUpdateRule implements BoundedUpdateRule, ClippableUpdateRule, NoisyUpdateRule
NeuronUpdateRule.InputType
DEFAULT_INCREMENT, increment, inputType
Constructor and Description |
---|
IACRule() |
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.
|
IACRule |
deepCopy()
Returns a deep copy of the update rule.
|
boolean |
getAddNoise()
Return true if add noise is turned on.
|
double |
getDecay() |
java.lang.String |
getDescription()
Returns a brief description of this update rule.
|
double |
getLowerBound()
Returns the lower bound.
|
Randomizer |
getNoiseGenerator()
Return the noise generator.
|
double |
getRest() |
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 |
setClipped(boolean clipping)
Turn clipping on and off.
|
void |
setDecay(double decay) |
void |
setLowerBound(double floor)
Sets the lower bound of this neuron update rule's activation.
|
void |
setNoiseGenerator(Randomizer noiseGenerator)
Set the noise generator.
|
void |
setRest(double rest) |
void |
setUpperBound(double ceiling)
Sets the upper bound of this neuron update rule's activation.
|
void |
update(Neuron neuron)
Apply the update rule.
|
clear, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, getToolTipText, incrementActivation, isSkipsSynapticUpdates, isSpikingNeuron, setIncrement, setInputType
public Network.TimeType getTimeType()
NeuronUpdateRule
getTimeType
in class NeuronUpdateRule
public IACRule deepCopy()
NeuronUpdateRule
deepCopy
in class NeuronUpdateRule
public void update(Neuron neuron)
NeuronUpdateRule
update
in class NeuronUpdateRule
neuron
- parent neuronpublic double clip(double val)
clip
in interface ClippableUpdateRule
val
- the value to clippublic void contextualIncrement(Neuron n)
contextualIncrement
in class NeuronUpdateRule
n
- neuron to be incrementedpublic void contextualDecrement(Neuron n)
contextualDecrement
in class NeuronUpdateRule
n
- neuronpublic double getDecay()
public void setDecay(double decay)
decay
- The decay to set.public double getRest()
public void setRest(double rest)
rest
- The rest to set.public boolean getAddNoise()
NoisyUpdateRule
getAddNoise
in interface NoisyUpdateRule
public void setAddNoise(boolean addNoise)
NoisyUpdateRule
setAddNoise
in interface NoisyUpdateRule
addNoise
- The addNoise to set.public Randomizer getNoiseGenerator()
NoisyUpdateRule
getNoiseGenerator
in interface NoisyUpdateRule
public void setNoiseGenerator(Randomizer noiseGenerator)
NoisyUpdateRule
setNoiseGenerator
in interface NoisyUpdateRule
noiseGenerator
- The noiseGenerator to set.public java.lang.String getDescription()
NeuronUpdateRule
getDescription
in class NeuronUpdateRule
public double getUpperBound()
BoundedUpdateRule
getUpperBound
in interface BoundedUpdateRule
public double getLowerBound()
BoundedUpdateRule
getLowerBound
in interface BoundedUpdateRule
public void setUpperBound(double ceiling)
BoundedUpdateRule
setUpperBound
in interface BoundedUpdateRule
ceiling
- the upper boundpublic void setLowerBound(double floor)
BoundedUpdateRule
setLowerBound
in interface BoundedUpdateRule
floor
- the lower boundpublic boolean isClipped()
ClippableUpdateRule
isClipped
in interface ClippableUpdateRule
public void setClipped(boolean clipping)
ClippableUpdateRule
setClipped
in interface ClippableUpdateRule
clipping
- true if clipping should be on; false otherwise