org.simbrain.network.neuron_update_rules.activity_generators

Class StochasticRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.core.SpikingNeuronUpdateRule

org.simbrain.network.neuron_update_rules.activity_generators.StochasticRule

All Implemented Interfaces:

ActivityGenerator

public class StochasticRule
extends SpikingNeuronUpdateRule
implements ActivityGenerator

StochasticNeuron is a simple type of random neuron which takes the value of the upper bound if a random variable is above a specified firing probability, and the lower bound otherwise. Ignores inputs.

Nested Class Summary

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

NeuronUpdateRule.InputType

Field Summary

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

DEFAULT_INCREMENT, increment, inputType

Constructor Summary

Constructors

Constructor and Description
StochasticRule()

Method Summary

Modifier and Type	Method and Description
StochasticRule	deepCopy() Returns a deep copy of the update rule.
java.lang.String	getDescription() Returns a brief description of this update rule.
double	getFiringProbability()
double	getLowerValue()
Network.TimeType	getTimeType() Returns the type of time update (discrete or continuous) associated with this neuron.
double	getUpperValue()
void	init(Neuron neuron) TODO: Doesn't feel like good API...
void	setFiringProbability(double firingProbability)
void	setLowerValue(double lowerValue)
void	setUpperValue(double upperValue)
void	update(Neuron neuron) Apply the update rule.

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

clear, getLastSpikeTime, isSpikingNeuron, setHasSpiked, setLastSpikeTime

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

contextualDecrement, contextualIncrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, getToolTipText, incrementActivation, isSkipsSynapticUpdates, setIncrement, setInputType

Methods inherited from class java.lang.Object

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

Constructor Detail

StochasticRule

public StochasticRule()

Method Detail

getTimeType

public Network.TimeType getTimeType()

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

Overrides:

getTimeType in class SpikingNeuronUpdateRule

Returns:

the time type

init

public void init(Neuron neuron)

TODO: Doesn't feel like good API... Used to set values of the neuron using this rule to accommodate this rule.

Specified by:

init in interface ActivityGenerator

deepCopy

public StochasticRule deepCopy()

Returns a deep copy of the update rule.

Specified by:

deepCopy in class NeuronUpdateRule

Returns:

Duplicated update rule

update

public void update(Neuron neuron)

Apply the update rule.

Specified by:

update in class SpikingNeuronUpdateRule

Parameters:

neuron - parent neuron

getFiringProbability

public double getFiringProbability()

Returns:

Returns the firingProbability.

setFiringProbability

public void setFiringProbability(double firingProbability)

Parameters:

firingProbability - The firingProbability 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.

getLowerValue

public double getLowerValue()

Returns:

the lowerValue

setLowerValue

public void setLowerValue(double lowerValue)

Parameters:

lowerValue - the lowerValue to set

getUpperValue

public double getUpperValue()

Returns:

the upperValue

setUpperValue

public void setUpperValue(double upperValue)

Parameters:

upperValue - the upperValue to set