.. index:: pair: class; WeightUpdateModels::Base
.. toctree::
:hidden:
:ref:`Base <doxid-d2/d05/classWeightUpdateModels_1_1Base>` class for all weight update models. :ref:`More...<details-d2/d05/classWeightUpdateModels_1_1Base>`
.. ref-code-block:: cpp
:class: doxyrest-overview-code-block
#include <weightUpdateModels.h>
class Base: public :ref:`Models::Base<doxid-d6/d97/classModels_1_1Base>`
{
public:
// methods
virtual std::string :ref:`getSimCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1aff2152fb55b5b0148491ca4eed9291eb>`() const;
virtual std::string :ref:`getEventCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a090f5529defe517fabf84c543209406f>`() const;
virtual std::string :ref:`getLearnPostCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1abd6d3ec97fb1da0f5750f71c7afc09b1>`() const;
virtual std::string :ref:`getSynapseDynamicsCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a307cb4e18479682b74972257c5d28dc5>`() const;
virtual std::string :ref:`getEventThresholdConditionCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a3157e0e66cdc654be4ef4ad67024f84d>`() const;
virtual std::string :ref:`getSimSupportCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a948b94c553782e9cc05a59bda014fe26>`() const;
virtual std::string :ref:`getLearnPostSupportCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1af98ae8f3d545f8d66d0f80662bf5b322>`() const;
virtual std::string :ref:`getSynapseDynamicsSuppportCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a7aae3190642d0bbe7f3f6fa01021783f>`() const;
virtual std::string :ref:`getPreSpikeCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a79e16d6c154e21a8ca7e56599cbe553b>`() const;
virtual std::string :ref:`getPostSpikeCode<doxid-d2/d05/classWeightUpdateModels_1_1Base_1abb81b1a933f13ba2af62c088387e186f>`() const;
virtual :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>` :ref:`getPreVars<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a949a9adcbc40d4ae9bbb51b2ec08dff5>`() const;
virtual :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>` :ref:`getPostVars<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a97a0a4fb30a66bb629cd88306e659105>`() const;
virtual bool :ref:`isPreSpikeTimeRequired<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a86fb753d87f35b53d789f96c6189a911>`() const;
virtual bool :ref:`isPostSpikeTimeRequired<doxid-d2/d05/classWeightUpdateModels_1_1Base_1ad93200ea885e60a88c108db10349edea>`() const;
size_t :ref:`getPreVarIndex<doxid-d2/d05/classWeightUpdateModels_1_1Base_1ac8b3e37eeb3f0034ebba50ec01c2840e>`(const std::string& varName) const;
size_t :ref:`getPostVarIndex<doxid-d2/d05/classWeightUpdateModels_1_1Base_1a5812718ff39cc394f1c6242e3d3f0987>`(const std::string& varName) const;
};
// direct descendants
class :ref:`PiecewiseSTDP<doxid-df/d86/classWeightUpdateModels_1_1PiecewiseSTDP>`;
class :ref:`StaticGraded<doxid-d6/d64/classWeightUpdateModels_1_1StaticGraded>`;
class :ref:`StaticPulse<doxid-d9/d74/classWeightUpdateModels_1_1StaticPulse>`;
class :ref:`StaticPulseDendriticDelay<doxid-d2/d53/classWeightUpdateModels_1_1StaticPulseDendriticDelay>`;
.. ref-code-block:: cpp
:class: doxyrest-overview-inherited-code-block
public:
// typedefs
typedef std::vector<std::string> :ref:`StringVec<doxid-db/d97/classSnippet_1_1Base_1a06cd0f6da1424a20163e12b6fec62519>`;
typedef std::vector<:ref:`EGP<doxid-dd/d5d/structSnippet_1_1Base_1_1EGP>`> :ref:`EGPVec<doxid-db/d97/classSnippet_1_1Base_1a43ece29884e2c6cabffe9abf985807c6>`;
typedef std::vector<:ref:`ParamVal<doxid-d7/dda/structSnippet_1_1Base_1_1ParamVal>`> :ref:`ParamValVec<doxid-db/d97/classSnippet_1_1Base_1a0156727ddf8f9c9cbcbc0d3d913b6b48>`;
typedef std::vector<:ref:`DerivedParam<doxid-d9/d0c/structSnippet_1_1Base_1_1DerivedParam>`> :ref:`DerivedParamVec<doxid-db/d97/classSnippet_1_1Base_1ad14217cebf11eddffa751a4d5c4792cb>`;
typedef std::vector<:ref:`Var<doxid-d5/d42/structModels_1_1Base_1_1Var>`> :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>`;
// structs
struct :ref:`DerivedParam<doxid-d9/d0c/structSnippet_1_1Base_1_1DerivedParam>`;
struct :ref:`EGP<doxid-dd/d5d/structSnippet_1_1Base_1_1EGP>`;
struct :ref:`ParamVal<doxid-d7/dda/structSnippet_1_1Base_1_1ParamVal>`;
struct :ref:`Var<doxid-d5/d42/structModels_1_1Base_1_1Var>`;
// methods
virtual :ref:`~Base<doxid-db/d97/classSnippet_1_1Base_1a17a9ca158277401f2c190afb1e791d1f>`();
virtual :ref:`StringVec<doxid-db/d97/classSnippet_1_1Base_1a06cd0f6da1424a20163e12b6fec62519>` :ref:`getParamNames<doxid-db/d97/classSnippet_1_1Base_1a0c8374854fbdc457bf0f75e458748580>`() const;
virtual :ref:`DerivedParamVec<doxid-db/d97/classSnippet_1_1Base_1ad14217cebf11eddffa751a4d5c4792cb>` :ref:`getDerivedParams<doxid-db/d97/classSnippet_1_1Base_1ab01de002618efa59541c927ffdd463f5>`() const;
virtual :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>` :ref:`getVars<doxid-d6/d97/classModels_1_1Base_1a9df8ba9bf6d971a574ed4745f6cf946c>`() const;
virtual :ref:`EGPVec<doxid-db/d97/classSnippet_1_1Base_1a43ece29884e2c6cabffe9abf985807c6>` :ref:`getExtraGlobalParams<doxid-d6/d97/classModels_1_1Base_1a7fdddb7d19382736b330ade62c441de1>`() const;
size_t :ref:`getVarIndex<doxid-d6/d97/classModels_1_1Base_1afa0e39df5002efc76448e180f82825e4>`(const std::string& varName) const;
size_t :ref:`getExtraGlobalParamIndex<doxid-d6/d97/classModels_1_1Base_1ae046c19ad56dfb2808c5f4d2cc7475fe>`(const std::string& paramName) const;
:ref:`Base <doxid-d2/d05/classWeightUpdateModels_1_1Base>` class for all weight update models.
.. index:: pair: function; getSimCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getSimCode() const
Gets simulation code run when 'true' spikes are received.
.. index:: pair: function; getEventCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getEventCode() const
Gets code run when events (all the instances where event threshold condition is met) are received.
.. index:: pair: function; getLearnPostCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getLearnPostCode() const
Gets code to include in the learnSynapsesPost kernel/function.
For examples when modelling STDP, this is where the effect of postsynaptic spikes which occur after presynaptic spikes are applied.
.. index:: pair: function; getSynapseDynamicsCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getSynapseDynamicsCode() const
Gets code for synapse dynamics which are independent of spike detection.
.. index:: pair: function; getEventThresholdConditionCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getEventThresholdConditionCode() const
Gets codes to test for events.
.. index:: pair: function; getSimSupportCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getSimSupportCode() const
Gets support code to be made available within the synapse kernel/function.
This is intended to contain user defined device functions that are used in the weight update code. Preprocessor defines are also allowed if appropriately safeguarded against multiple definition by using ifndef; functions should be declared as "__host__ __device__" to be available for both GPU and CPU versions; note that this support code is available to sim, event threshold and event code
.. index:: pair: function; getLearnPostSupportCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getLearnPostSupportCode() const
Gets support code to be made available within learnSynapsesPost kernel/function.
Preprocessor defines are also allowed if appropriately safeguarded against multiple definition by using ifndef; functions should be declared as "__host__ __device__" to be available for both GPU and CPU versions.
.. index:: pair: function; getSynapseDynamicsSuppportCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getSynapseDynamicsSuppportCode() const
Gets support code to be made available within the synapse dynamics kernel/function.
Preprocessor defines are also allowed if appropriately safeguarded against multiple definition by using ifndef; functions should be declared as "__host__ __device__" to be available for both GPU and CPU versions.
.. index:: pair: function; getPreSpikeCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getPreSpikeCode() const
Gets code to be run once per spiking presynaptic neuron before sim code is run on synapses
This is typically for the code to update presynaptic variables. Postsynaptic and synapse variables are not accesible from within this code
.. index:: pair: function; getPostSpikeCode
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual std::string getPostSpikeCode() const
Gets code to be run once per spiking postsynaptic neuron before learn post code is run on synapses
This is typically for the code to update postsynaptic variables. Presynaptic and synapse variables are not accesible from within this code
.. index:: pair: function; getPreVars
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>` getPreVars() const
Gets names and types (as strings) of state variables that are common across all synapses coming from the same presynaptic neuron
.. index:: pair: function; getPostVars
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual :ref:`VarVec<doxid-d6/d97/classModels_1_1Base_1a5a6bc95969a38ac1ac68ab4a0ba94c75>` getPostVars() const
Gets names and types (as strings) of state variables that are common across all synapses going to the same postsynaptic neuron
.. index:: pair: function; isPreSpikeTimeRequired
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual bool isPreSpikeTimeRequired() const
Whether presynaptic spike times are needed or not.
.. index:: pair: function; isPostSpikeTimeRequired
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
virtual bool isPostSpikeTimeRequired() const
Whether postsynaptic spike times are needed or not.
.. index:: pair: function; getPreVarIndex
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
size_t getPreVarIndex(const std::string& varName) const
Find the index of a named presynaptic variable.
.. index:: pair: function; getPostVarIndex
.. ref-code-block:: cpp
:class: doxyrest-title-code-block
size_t getPostVarIndex(const std::string& varName) const
Find the index of a named postsynaptic variable.