GeNN  4.9.0
GPU enhanced Neuronal Networks (GeNN)
Classes | Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
Snippet::Base Class Reference

Base class for all code snippets. More...

#include <snippet.h>

Inheritance diagram for Snippet::Base:
InitSparseConnectivitySnippet::Base InitToeplitzConnectivitySnippet::Base InitVarSnippet::Base Models::Base InitSparseConnectivitySnippet::Conv2D InitSparseConnectivitySnippet::FixedNumberPostWithReplacement InitSparseConnectivitySnippet::FixedNumberPreWithReplacement InitSparseConnectivitySnippet::FixedNumberTotalWithReplacement InitSparseConnectivitySnippet::FixedProbabilityBase InitSparseConnectivitySnippet::OneToOne InitSparseConnectivitySnippet::Uninitialised InitToeplitzConnectivitySnippet::AvgPoolConv2D InitToeplitzConnectivitySnippet::Conv2D InitToeplitzConnectivitySnippet::Uninitialised InitVarSnippet::Binomial InitVarSnippet::Constant InitVarSnippet::Exponential InitVarSnippet::Gamma InitVarSnippet::Kernel InitVarSnippet::Normal InitVarSnippet::NormalClipped InitVarSnippet::NormalClippedDelay InitVarSnippet::Uniform InitVarSnippet::Uninitialised CurrentSourceModels::Base CustomUpdateModels::Base NeuronModels::Base PostsynapticModels::Base WeightUpdateModels::Base

Classes

struct  DerivedParam
 A derived parameter has a name and a function for obtaining its value. More...
 
struct  EGP
 An extra global parameter has a name and a type. More...
 
struct  ParamVal
 Additional input variables, row state variables and other things have a name, a type and an initial value. More...
 

Public Types

typedef std::vector< std::string > StringVec
 
typedef std::vector< EGP > EGPVec
 
typedef std::vector< ParamVal > ParamValVec
 
typedef std::vector< DerivedParam > DerivedParamVec
 

Public Member Functions

virtual ~Base ()
 
virtual StringVec getParamNames () const
 Gets names of of (independent) model parameters. More...
 
virtual DerivedParamVec getDerivedParams () const
 
virtual EGPVec getExtraGlobalParams () const
 
size_t getExtraGlobalParamIndex (const std::string &paramName) const
 Find the index of a named extra global parameter. More...
 

Protected Member Functions

void updateHash (boost::uuids::detail::sha1 &hash) const
 
void validate () const
 Validate names of parameters etc. More...
 

Static Protected Member Functions

template<typename T >
static size_t getNamedVecIndex (const std::string &name, const std::vector< T > &vec)
 

Detailed Description

Base class for all code snippets.

Member Typedef Documentation

◆ DerivedParamVec

typedef std::vector<DerivedParam> Snippet::Base::DerivedParamVec

◆ EGPVec

typedef std::vector<EGP> Snippet::Base::EGPVec

◆ ParamValVec

typedef std::vector<ParamVal> Snippet::Base::ParamValVec

◆ StringVec

typedef std::vector<std::string> Snippet::Base::StringVec

Constructor & Destructor Documentation

◆ ~Base()

virtual Snippet::Base::~Base ( )
inlinevirtual

Member Function Documentation

◆ getDerivedParams()

virtual DerivedParamVec Snippet::Base::getDerivedParams ( ) const
inlinevirtual

Gets names of derived model parameters and the function objects to call to Calculate their value from a vector of model parameter values

Reimplemented in NeuronModels::PoissonNew, WeightUpdateModels::PiecewiseSTDP, NeuronModels::LIF, InitVarSnippet::NormalClippedDelay, InitToeplitzConnectivitySnippet::AvgPoolConv2D, NeuronModels::RulkovMap, InitSparseConnectivitySnippet::FixedProbabilityBase, CurrentSourceModels::PoissonExp, InitToeplitzConnectivitySnippet::Conv2D, PostsynapticModels::ExpCond, and PostsynapticModels::ExpCurr.

◆ getExtraGlobalParamIndex()

size_t Snippet::Base::getExtraGlobalParamIndex ( const std::string &  paramName) const
inline

Find the index of a named extra global parameter.

◆ getExtraGlobalParams()

virtual EGPVec Snippet::Base::getExtraGlobalParams ( ) const
inlinevirtual

Gets names and types (as strings) of additional per-population parameters for the snippet

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

◆ getNamedVecIndex()

template<typename T >
static size_t Snippet::Base::getNamedVecIndex ( const std::string &  name,
const std::vector< T > &  vec 
)
inlinestaticprotected

◆ getParamNames()

virtual StringVec Snippet::Base::getParamNames ( ) const
inlinevirtual

Gets names of of (independent) model parameters.

Reimplemented in NeuronModels::TraubMilesNStep, NeuronModels::TraubMiles, InitSparseConnectivitySnippet::Conv2D, NeuronModels::PoissonNew, InitSparseConnectivitySnippet::FixedNumberPreWithReplacement, NeuronModels::Poisson, WeightUpdateModels::PiecewiseSTDP, InitSparseConnectivitySnippet::FixedNumberTotalWithReplacement, InitSparseConnectivitySnippet::FixedNumberPostWithReplacement, WeightUpdateModels::StaticGraded, NeuronModels::LIF, InitVarSnippet::Binomial, InitVarSnippet::Gamma, NeuronModels::IzhikevichVariable, InitVarSnippet::Exponential, NeuronModels::Izhikevich, InitVarSnippet::NormalClippedDelay, InitToeplitzConnectivitySnippet::AvgPoolConv2D, InitVarSnippet::NormalClipped, InitSparseConnectivitySnippet::FixedProbabilityBase, NeuronModels::RulkovMap, InitVarSnippet::Normal, CurrentSourceModels::PoissonExp, InitToeplitzConnectivitySnippet::Conv2D, InitVarSnippet::Uniform, PostsynapticModels::ExpCond, CurrentSourceModels::GaussianNoise, InitVarSnippet::Constant, CurrentSourceModels::DC, and PostsynapticModels::ExpCurr.

◆ updateHash()

void Snippet::Base::updateHash ( boost::uuids::detail::sha1 &  hash) const
inlineprotected

◆ validate()

void Snippet::Base::validate ( ) const
inlineprotected

Validate names of parameters etc.

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