org.simbrain.network.core

Class SynapseUpdateRule

java.lang.Object

org.simbrain.network.core.SynapseUpdateRule

Direct Known Subclasses:

HebbianCPCARule, HebbianRule, HebbianThresholdRule, OjaRule, ShortTermPlasticityRule, StaticSynapseRule, STDPRule, SubtractiveNormalizationRule

public abstract class SynapseUpdateRule
extends java.lang.Object

A rule for updating a synapse. A learning rule.

Author:

jyoshimi

Constructor Summary

Constructors

Constructor and Description
SynapseUpdateRule()

Method Summary

Modifier and Type	Method and Description
void	clear(Synapse synapse) Set activation to 0; override for other "clearing" behavior (e.g.
abstract SynapseUpdateRule	deepCopy() Returns a deep copy of the update rule.
abstract java.lang.String	getDescription() Returns a brief description of this update rule.
java.lang.String	getToolTipText(Synapse synapse) Returns string for tool tip or short description.
abstract void	init(Synapse synapse) Initialize the update rule and make necessary changes to the parent synapse.
abstract void	update(Synapse synapse) Apply the update rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynapseUpdateRule

public SynapseUpdateRule()

Method Detail

init

public abstract void init(Synapse synapse)

Initialize the update rule and make necessary changes to the parent synapse.

Parameters:

synapse - parent synapse

update

public abstract void update(Synapse synapse)

Apply the update rule.

Parameters:

synapse - parent synapse

deepCopy

public abstract SynapseUpdateRule deepCopy()

Returns a deep copy of the update rule.

Returns:

Duplicated update rule

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.

clear

public void clear(Synapse synapse)

Set activation to 0; override for other "clearing" behavior (e.g. setting other variables to 0. Called in Gui when "clear" button pressed.

Parameters:

synapse - reference to parent synapse

getToolTipText

public java.lang.String getToolTipText(Synapse synapse)

Returns string for tool tip or short description. Override to provide custom information.

Parameters:

synapse - reference to parent synapse

Returns:

tool tip text