GeNN  3.3.0
GPU enhanced Neuronal Networks (GeNN)
NeuronModels::Base Class Reference

Base class for all neuron models. More...

#include <newNeuronModels.h>

Inheritance diagram for NeuronModels::Base:
NewModels::Base Snippet::Base NeuronModels::Izhikevich NeuronModels::Poisson NeuronModels::PoissonNew NeuronModels::RulkovMap NeuronModels::SpikeSource NeuronModels::SpikeSourceArray NeuronModels::TraubMiles NeuronModels::IzhikevichVariable NeuronModels::TraubMilesAlt NeuronModels::TraubMilesFast NeuronModels::TraubMilesNStep

Public Member Functions

virtual std::string getSimCode () const
 Gets the code that defines the execution of one timestep of integration of the neuron model. More...
 
virtual std::string getThresholdConditionCode () const
 Gets code which defines the condition for a true spike in the described neuron model. More...
 
virtual std::string getResetCode () const
 Gets code that defines the reset action taken after a spike occurred. This can be empty. More...
 
virtual std::string getSupportCode () const
 Gets support code to be made available within the neuron kernel/funcion. More...
 
virtual NewModels::Base::StringPairVec getExtraGlobalParams () const
 
virtual NewModels::Base::NameTypeValVec getAdditionalInputVars () const
 
- Public Member Functions inherited from NewModels::Base
virtual StringPairVec getVars () const
 Gets names and types (as strings) of model variables. More...
 
size_t getVarIndex (const std::string &varName) const
 Find the index of a named variable. More...
 
- Public Member Functions inherited from Snippet::Base
virtual ~Base ()
 
virtual StringVec getParamNames () const
 Gets names of of (independent) model parameters. More...
 
virtual DerivedParamVec getDerivedParams () const
 

Additional Inherited Members

- Public Types inherited from Snippet::Base
typedef std::function< double(const std::vector< double > &, double)> DerivedParamFunc
 
typedef std::vector< std::string > StringVec
 
typedef std::vector< std::pair< std::string, std::string > > StringPairVec
 
typedef std::vector< std::pair< std::string, std::pair< std::string, double > > > NameTypeValVec
 
typedef std::vector< std::pair< std::string, DerivedParamFunc > > DerivedParamVec
 
- Static Protected Member Functions inherited from NewModels::Base
static size_t getVarIndex (const std::string &varName, const StringPairVec &vars)
 

Detailed Description

Base class for all neuron models.

Member Function Documentation

◆ getAdditionalInputVars()

virtual NewModels::Base::NameTypeValVec NeuronModels::Base::getAdditionalInputVars ( ) const
inlinevirtual

Gets names, types (as strings) and initial values of local variables into which the 'apply input code' of (potentially) multiple postsynaptic input models can apply input

◆ getExtraGlobalParams()

virtual NewModels::Base::StringPairVec NeuronModels::Base::getExtraGlobalParams ( ) const
inlinevirtual

Gets names and types (as strings) of additional per-population parameters for the weight update model.

Reimplemented in NeuronModels::Poisson, and NeuronModels::SpikeSourceArray.

◆ getResetCode()

virtual std::string NeuronModels::Base::getResetCode ( ) const
inlinevirtual

Gets code that defines the reset action taken after a spike occurred. This can be empty.

Reimplemented in NeuronModels::SpikeSourceArray.

◆ getSimCode()

virtual std::string NeuronModels::Base::getSimCode ( ) const
inlinevirtual

Gets the code that defines the execution of one timestep of integration of the neuron model.

The code will refer to for the value of the variable with name "NN". It needs to refer to the predefined variable "ISYN", i.e. contain , if it is to receive input.

Reimplemented in NeuronModels::TraubMilesNStep, NeuronModels::TraubMilesAlt, NeuronModels::TraubMilesFast, NeuronModels::TraubMiles, NeuronModels::PoissonNew, NeuronModels::Poisson, NeuronModels::SpikeSourceArray, NeuronModels::Izhikevich, and NeuronModels::RulkovMap.

◆ getSupportCode()

virtual std::string NeuronModels::Base::getSupportCode ( ) const
inlinevirtual

Gets support code to be made available within the neuron kernel/funcion.

This is intended to contain user defined device functions that are used in the neuron codes. 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.

◆ getThresholdConditionCode()

virtual std::string NeuronModels::Base::getThresholdConditionCode ( ) const
inlinevirtual

Gets code which defines the condition for a true spike in the described neuron model.

This evaluates to a bool (e.g. "V > 20").

Reimplemented in NeuronModels::TraubMiles, NeuronModels::PoissonNew, NeuronModels::Poisson, NeuronModels::SpikeSourceArray, NeuronModels::SpikeSource, NeuronModels::Izhikevich, and NeuronModels::RulkovMap.


The documentation for this class was generated from the following file: