class Models::Base

Overview

Base class for all models - in addition to the parameters snippets have, models can have state variables. More…

#include <models.h>

class Base: public Snippet::Base
{
public:
    // typedefs

    typedef std::vector<Var> VarVec;

    // structs

    struct Var;

    // methods

    virtual VarVec getVars() const;
    virtual EGPVec getExtraGlobalParams() const;
    size_t getVarIndex(const std::string& varName) const;
    size_t getExtraGlobalParamIndex(const std::string& paramName) const;
};

// direct descendants

class Base;
class Base;
class Base;
class Base;

Inherited Members

public:
    // typedefs

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

    // structs

    struct DerivedParam;
    struct EGP;
    struct ParamVal;

    // methods

    virtual ~Base();
    virtual StringVec getParamNames() const;
    virtual DerivedParamVec getDerivedParams() const;

Detailed Documentation

Base class for all models - in addition to the parameters snippets have, models can have state variables.

Methods

virtual VarVec getVars() const

Gets names and types (as strings) of model variables.

virtual EGPVec getExtraGlobalParams() const

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

size_t getVarIndex(const std::string& varName) const

Find the index of a named variable.

size_t getExtraGlobalParamIndex(const std::string& paramName) const

Find the index of a named extra global parameter.