public class NakaRushtonRule extends NeuronUpdateRule implements BoundedUpdateRule, NoisyUpdateRule
NeuronUpdateRule.InputType
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_UPPER_BOUND
The default activation ceiling.
|
DEFAULT_INCREMENT, increment, inputType
Constructor and Description |
---|
NakaRushtonRule()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
clear(Neuron neuron)
Set activation to 0; override for other "clearing" behavior (e.g.
|
void |
contextualIncrement(Neuron n)
Increment a neuron by increment, respecting neuron specific constraints.
|
NakaRushtonRule |
deepCopy()
Returns a deep copy of the update rule.
|
double |
getAdaptationParameter()
Return the adaptation parameter.
|
double |
getAdaptationTimeConstant() |
boolean |
getAddNoise()
Return true if add noise is turned on.
|
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 |
getSemiSaturationConstant() |
double |
getSteepness() |
double |
getTimeConstant() |
Network.TimeType |
getTimeType()
Returns the type of time update (discrete or continuous) associated with
this neuron.
|
java.lang.String |
getToolTipText(Neuron neuron)
Returns string for tool tip or short description.
|
double |
getUpperBound()
Returns the upper bound.
|
boolean |
getUseAdaptation() |
void |
setAdaptationParameter(double adaptationParameter)
Sets the adaptation parameter.
|
void |
setAdaptationTimeConstant(double adaptationTimeConstant)
Sets the adaptation time constant.
|
void |
setAddNoise(boolean addNoise)
Set whether noise should be used.
|
void |
setLowerBound(double floor)
Sets the lower bound of this neuron update rule's activation.
|
void |
setNoiseGenerator(Randomizer noiseGenerator)
Set the noise generator.
|
void |
setSemiSaturationConstant(double semiSaturationConstant) |
void |
setSteepness(double steepness) |
void |
setTimeConstant(double timeConstant) |
void |
setUpperBound(double ceiling)
Sets the upper bound of this neuron update rule's activation.
|
void |
setUseAdaptation(boolean useAdaptation)
Sets the boolean use adaptation value.
|
void |
update(Neuron neuron)
Apply the update rule.
|
contextualDecrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, incrementActivation, isSkipsSynapticUpdates, isSpikingNeuron, setIncrement, setInputType
public static final int DEFAULT_UPPER_BOUND
public Network.TimeType getTimeType()
getTimeType
in class NeuronUpdateRule
public NakaRushtonRule deepCopy()
deepCopy
in class NeuronUpdateRule
public void update(Neuron neuron)
update
in class NeuronUpdateRule
neuron
- parent neuronpublic void contextualIncrement(Neuron n)
NeuronUpdateRule
contextualIncrement
in class NeuronUpdateRule
n
- neuron to be incrementedpublic double getSemiSaturationConstant()
public void setSemiSaturationConstant(double semiSaturationConstant)
semiSaturationConstant
- The semiSaturationConstant to set.public double getSteepness()
public void setSteepness(double steepness)
steepness
- The steepness to set.public double getTimeConstant()
public void setTimeConstant(double timeConstant)
timeConstant
- The timeConstant 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 boolean getUseAdaptation()
public void setUseAdaptation(boolean useAdaptation)
useAdaptation
- Value to set use adaptation topublic double getAdaptationTimeConstant()
public void setAdaptationTimeConstant(double adaptationTimeConstant)
adaptationTimeConstant
- Value to set adaptation time constantpublic void clear(Neuron neuron)
NeuronUpdateRule
clear
in class NeuronUpdateRule
neuron
- reference to parent neuronpublic java.lang.String getToolTipText(Neuron neuron)
NeuronUpdateRule
getToolTipText
in class NeuronUpdateRule
neuron
- reference to parent neuronpublic double getAdaptationParameter()
public void setAdaptationParameter(double adaptationParameter)
adaptationParameter
- value to setpublic java.lang.String getDescription()
getDescription
in class NeuronUpdateRule
public double getUpperBound()
BoundedUpdateRule
getUpperBound
in interface BoundedUpdateRule
public void setUpperBound(double ceiling)
BoundedUpdateRule
setUpperBound
in interface BoundedUpdateRule
ceiling
- the upper boundpublic double getLowerBound()
BoundedUpdateRule
getLowerBound
in interface BoundedUpdateRule
public void setLowerBound(double floor)
BoundedUpdateRule
setLowerBound
in interface BoundedUpdateRule
floor
- the lower bound