NeuronUpdateRule (Simbrain API)

java.lang.Object
- org.simbrain.network.core.NeuronUpdateRule

Direct Known Subclasses:

AbstractSigmoidalRule, AdditiveRule, BinaryRule, DecayRule, IACRule, LinearRule, LogisticRule, NakaRushtonRule, PointNeuronRule, RandomNeuronRule, RunningAverageRule, SinusoidalRule, SpikingNeuronUpdateRule, ThreeValueRule
```
public abstract class NeuronUpdateRule
extends java.lang.Object
```
A rule for updating a neuron.

Author:

jyoshimi

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NeuronUpdateRule.InputType
An enum specifying how a neuron sums its inputs.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NeuronUpdateRule.InputType` An enum specifying how a neuron sums its inputs.

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_INCREMENT` The default increment of a neuron using this rule.
`protected double`	`increment` Amount by which to increment or decrement neuron.
`protected NeuronUpdateRule.InputType`	`inputType`

Constructor Summary

Constructors
Constructor and Description

NeuronUpdateRule()

Constructors
Constructor and Description
`NeuronUpdateRule()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear(Neuron neuron)` Set activation to 0; override for other "clearing" behavior (e.g.
`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.
`void`	`decrementActivation(Neuron n)` Decrement a neuron by increment.
`abstract NeuronUpdateRule`	`deepCopy()` Returns a deep copy of the update rule.
`static double`	`getDefaultIncrement()`
`abstract 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`	`getIncrement()`
`NeuronUpdateRule.InputType`	`getInputType()`
`double`	`getRandomValue()` Returns a random value between the upper and lower bounds of this neuron.
`abstract 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.
`void`	`incrementActivation(Neuron n)` Increment a neuron by increment.
`boolean`	`isSkipsSynapticUpdates()`
`boolean`	`isSpikingNeuron()`
`void`	`setIncrement(double increment)`
`void`	`setInputType(NeuronUpdateRule.InputType inputType)`
`abstract void`	`update(Neuron neuron)` Apply the update rule.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_INCREMENT
```
public static final double DEFAULT_INCREMENT
```
    The default increment of a neuron using this rule.
    
    See Also:
    
    Constant Field Values
  - inputType
```
protected NeuronUpdateRule.InputType inputType
```
  - increment
```
protected double increment
```
    Amount by which to increment or decrement neuron.
- Constructor Detail
  - NeuronUpdateRule
```
public NeuronUpdateRule()
```
- Method Detail
  - getTimeType
```
public abstract Network.TimeType getTimeType()
```
    Returns the type of time update (discrete or continuous) associated with this neuron.
    
    Returns:
    
    the time type
  - update
```
public abstract void update(Neuron neuron)
```
    Apply the update rule.
    
    Parameters:
    
    neuron - parent neuron
  - deepCopy
```
public abstract NeuronUpdateRule deepCopy()
```
    Returns a deep copy of the update rule.
    
    Returns:
    
    Duplicated update rule
  - incrementActivation
```
public final void incrementActivation(Neuron n)
```
    Increment a neuron by increment.
    
    Parameters:
    
    n - neuron
  - decrementActivation
```
public final void decrementActivation(Neuron n)
```
    Decrement a neuron by increment.
    
    Parameters:
    
    n - neuron
  - contextualIncrement
```
public void contextualIncrement(Neuron n)
```
    Increment a neuron by increment, respecting neuron specific constraints. Intended to be overriden.
    
    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.
    
    Parameters:
    
    n - 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.
    
    Returns:
    
    the random value.
  - getGraphicalLowerBound
```
public double getGraphicalLowerBound()
```
    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.
    
    Returns:
    
    the graphical lower bound
  - getGraphicalUpperBound
```
public double getGraphicalUpperBound()
```
    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.
    
    Returns:
    
    the graphical upper bound
  - clear
```
public void clear(Neuron neuron)
```
    Set activation to 0; override for other "clearing" behavior (e.g. setting other variables to 0. Called in Gui when "clear" button pressed.
    
    Parameters:
    
    neuron - reference to parent neuron
  - getDescription
```
public abstract java.lang.String getDescription()
```
    Returns a brief description of this update rule. Used in combo boxes in the GUI.
    
    Returns:
    
    the description.
  - getToolTipText
```
public java.lang.String getToolTipText(Neuron neuron)
```
    Returns string for tool tip or short description. Override to provide custom information.
    
    Parameters:
    
    neuron - reference to parent neuron
    
    Returns:
    
    tool tip text
  - getIncrement
```
public double getIncrement()
```
    Returns:
    
    the increment
  - setIncrement
```
public void setIncrement(double increment)
```
    Parameters:
    
    increment - the increment to set
  - getDefaultIncrement
```
public static double getDefaultIncrement()
```
    Returns:
    
    the defaultIncrement
  - getInputType
```
public NeuronUpdateRule.InputType getInputType()
```
  - setInputType
```
public void setInputType(NeuronUpdateRule.InputType inputType)
```
  - isSpikingNeuron
```
public boolean isSpikingNeuron()
```
  - isSkipsSynapticUpdates
```
public boolean isSkipsSynapticUpdates()
```

Class NeuronUpdateRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INCREMENT

inputType

increment

Constructor Detail

NeuronUpdateRule

Method Detail

getTimeType

update

deepCopy

incrementActivation

decrementActivation

contextualIncrement

contextualDecrement

getRandomValue

getGraphicalLowerBound

getGraphicalUpperBound

clear

getDescription

getToolTipText

getIncrement

setIncrement

getDefaultIncrement

getInputType

setInputType

isSpikingNeuron

isSkipsSynapticUpdates