standardSubstitutions.h

Go to the documentation of this file.

#pragma once

// Standard includes
#include <string>

// GeNN includes
#include "codeGenUtils.h"
#include "initSparseConnectivitySnippet.h"
#include "newNeuronModels.h"

// Forward declarations
class NeuronGroup;
class SynapseGroup;
class CurrentSource;

//----------------------------------------------------------------------------
// NameIterCtx
//----------------------------------------------------------------------------
template<typename Container>
struct NameIterCtx
{
    typedef PairKeyConstIter<typename Container::const_iterator> NameIter;

    NameIterCtx(const Container &c) :
        container(c), nameBegin(std::begin(container)), nameEnd(std::end(container)){}

    const Container container;
    const NameIter nameBegin;
    const NameIter nameEnd;
};

//----------------------------------------------------------------------------
// Typedefines
//----------------------------------------------------------------------------
typedef NameIterCtx<NewModels::Base::StringPairVec> VarNameIterCtx;
typedef NameIterCtx<NewModels::Base::DerivedParamVec> DerivedParamNameIterCtx;
typedef NameIterCtx<NewModels::Base::StringPairVec> ExtraGlobalParamNameIterCtx;

//----------------------------------------------------------------------------
// Standard substitution functins
//----------------------------------------------------------------------------
namespace StandardSubstitutions
{
void postSynapseApplyInput(
    std::string &psCode,                                    
    const SynapseGroup *sg,                                 
    const NeuronGroup &ng,                                  
    const VarNameIterCtx &nmVars,
    const DerivedParamNameIterCtx &nmDerivedParams,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams, 
    const std::vector<FunctionTemplate> &functions,         
    const std::string &ftype,                               
    const std::string &rng);                                

void postSynapseDecay(
    std::string &pdCode,
    const SynapseGroup *sg,
    const NeuronGroup &ng,
    const VarNameIterCtx &nmVars,
    const DerivedParamNameIterCtx &nmDerivedParams,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void neuronThresholdCondition(
    std::string &thCode,
    const NeuronGroup &ng,
    const VarNameIterCtx &nmVars,
    const DerivedParamNameIterCtx &nmDerivedParams,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void neuronSim(
    std::string &sCode,
    const NeuronGroup &ng,
    const VarNameIterCtx &nmVars,
    const DerivedParamNameIterCtx &nmDerivedParams,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void neuronSpikeEventCondition(
    std::string &eCode,
    const NeuronGroup &ng,
    const VarNameIterCtx &nmVars,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void neuronReset(
    std::string &rCode,
    const NeuronGroup &ng,
    const VarNameIterCtx &nmVars,
    const DerivedParamNameIterCtx &nmDerivedParams,
    const ExtraGlobalParamNameIterCtx &nmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void weightUpdateThresholdCondition(
    std::string &eCode,
    const SynapseGroup &sg,
    const DerivedParamNameIterCtx &wuDerivedParams,
    const ExtraGlobalParamNameIterCtx &wuExtraGlobalParams,
    const string &preIdx, 
    const string &postIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    double dt);

void weightUpdateSim(
    std::string &wCode,
    const SynapseGroup &sg,
    const VarNameIterCtx &wuVars,
    const VarNameIterCtx &wuPreVars,
    const VarNameIterCtx &wuPostVars,
    const DerivedParamNameIterCtx &wuDerivedParams,
    const ExtraGlobalParamNameIterCtx &wuExtraGlobalParams,
    const string &preIdx, 
    const string &postIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    double dt);

void weightUpdateDynamics(
    std::string &SDcode,
    const SynapseGroup *sg,
    const VarNameIterCtx &wuVars,
    const VarNameIterCtx &wuPreVars,
    const VarNameIterCtx &wuPostVars,
    const DerivedParamNameIterCtx &wuDerivedParams,
    const ExtraGlobalParamNameIterCtx &wuExtraGlobalParams,
    const string &preIdx, 
    const string &postIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    double dt);

void weightUpdatePostLearn(
    std::string &code,
    const SynapseGroup *sg,
    const VarNameIterCtx &wuPreVars,
    const VarNameIterCtx &wuPostVars,
    const DerivedParamNameIterCtx &wuDerivedParams,
    const ExtraGlobalParamNameIterCtx &wuExtraGlobalParams,
    const string &preIdx, 
    const string &postIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    double dt,
    const string &preVarPrefix = "",    
    const string &preVarSuffix = "",    
    const string &postVarPrefix = "",   
    const string &postVarSuffix = "");  

void weightUpdatePreSpike(
    std::string &code,
    const SynapseGroup *sg,
    const string &preIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype);


void weightUpdatePostSpike(
    std::string &code,
    const SynapseGroup *sg,
    const string &postIdx, 
    const string &devPrefix,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype);

std::string initNeuronVariable(
    const NewModels::VarInit &varInit,
    const std::string &varName,
    const std::vector<FunctionTemplate> &functions,
    const std::string &idx,
    const std::string &ftype,
    const std::string &rng);

std::string initWeightUpdateVariable(
    const NewModels::VarInit &varInit,
    const std::string &varName,
    const std::vector<FunctionTemplate> &functions,
        const std::string &preIdx,
        const std::string &postIdx,
    const std::string &ftype,
    const std::string &rng);

std::string initSparseConnectivity(
    const SynapseGroup &sg,
    const std::string &addSynapseFunctionTemplate,
    unsigned int numTrgNeurons,
    const std::string &preIdx,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);

void currentSourceInjection(
    std::string &code,
    const CurrentSource *sc,
    const VarNameIterCtx &scmVars,
    const DerivedParamNameIterCtx &scmDerivedParams,
    const ExtraGlobalParamNameIterCtx &scmExtraGlobalParams,
    const std::vector<FunctionTemplate> &functions,
    const std::string &ftype,
    const std::string &rng);
}   // StandardSubstitions