org.simbrain.network.neuron_update_rules

Class BinaryRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.neuron_update_rules.BinaryRule

public class BinaryRule
extends NeuronUpdateRule

BinaryNeuron takes one of two values.

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
BinaryRule()

Method Summary

Modifier and Type	Method and Description
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.
BinaryRule	deepCopy() Returns a deep copy of the update rule.
double	getBias()
java.lang.String	getDescription() Returns a brief description of this update rule.
double	getGraphicalLowerBound() Returns a value for lower bound to be used in computing the saturation of neuron nodes.
double	getGraphicalUpperBound() Returns a value for upper bound to be used in computing the saturation of neuron nodes.
double	getLowerBound()
double	getRandomValue() Returns a random value between the upper and lower bounds of this neuron.
double	getThreshold()
Network.TimeType	getTimeType() Returns the type of time update (discrete or continuous) associated with this neuron.
double	getUpperBound()
void	setBias(double bias)
void	setCeiling(double ceiling)
void	setFloor(double floor)
void	setThreshold(double threshold)
void	update(Neuron neuron) Apply the update rule.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryRule

public BinaryRule()

Method Detail

getTimeType

public Network.TimeType getTimeType()

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

Specified by:

getTimeType in class NeuronUpdateRule

Returns:

the time type

deepCopy

public BinaryRule 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 NeuronUpdateRule

Parameters:

neuron - parent neuron

getRandomValue

public double getRandomValue()

Returns a random value between the upper and lower bounds of this neuron. Update rules that require special randomization should override this method.

Overrides:

getRandomValue in class NeuronUpdateRule

Returns:

the random value.

getThreshold

public double getThreshold()

Returns:

Returns the threshold.

setThreshold

public void setThreshold(double threshold)

Parameters:

threshold - The threshold to set.

getBias

public double getBias()

Returns:

the bias of the neuron.

setBias

public void setBias(double bias)

Parameters:

bias - sets the bias of the neuron.

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()

setCeiling

public void setCeiling(double ceiling)

getLowerBound

public double getLowerBound()

setFloor

public void setFloor(double floor)

contextualIncrement

public void contextualIncrement(Neuron n)

Description copied from class: NeuronUpdateRule

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)

Description copied from class: NeuronUpdateRule

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

Overrides:

contextualDecrement in class NeuronUpdateRule

Parameters:

n - neuron

getGraphicalLowerBound

public double getGraphicalLowerBound()

Description copied from class: NeuronUpdateRule

Returns a value for lower bound to be used in computing the saturation of neuron nodes. Override this to produce nicer graphics, and fine tune based on display of neurons in common use cases for a given neuron type.

Overrides:

getGraphicalLowerBound in class NeuronUpdateRule

Returns:

the graphical lower bound

getGraphicalUpperBound

public double getGraphicalUpperBound()

Description copied from class: NeuronUpdateRule

Returns a value for upper bound to be used in computing the saturation of neuron nodes. Override this to produce nicer graphics, and fine tune based on display of neurons in common use cases for a given neuron type.

Overrides:

getGraphicalUpperBound in class NeuronUpdateRule

Returns:

the graphical upper bound