Allow combination of continuous-valued third factor and spike-based third factor (#1264)

Author: clinssen

doc/running/running_nest.rst

@@ -282,7 +282,7 @@ Additionally, if the synapse requires it, specify the ``"post_ports"`` entry to
                                                            "post_ports": ["post_spikes",
                                                                           ["I_post_dend", "I_dend"]]}]})
 
-This specifies that the neuron ``iaf_psc_exp_dend`` has to be generated paired with the synapse ``third_factor_stdp``, and that the input ports ``post_spikes`` and ``I_post_dend`` in the synapse are to be connected to the postsynaptic partner. For the ``I_post_dend`` input port, the corresponding variable in the (postsynaptic) neuron is called ``I_dend``.
+This specifies that the neuron ``iaf_psc_exp_dend`` has to be generated paired with the synapse ``third_factor_stdp``, and that the input ports ``post_spikes`` and ``I_post_dend`` in the synapse are to be connected to the postsynaptic partner. For the ``I_post_dend`` input port, the corresponding variable in the (postsynaptic) neuron is called ``I_dend``. Note that inline expressions can also be used; in this example in case ``I_dend`` had been an inline expression in the postsynaptic neuron.
 
 To prevent the NESTML code generator from moving specific variables from synapse into postsynaptic neuron, the code generation option ``strictly_synaptic_vars`` may be used (see https://nestml.readthedocs.io/en/latest/pynestml.transformers.html#pynestml.transformers.synapse_post_neuron_transformer.SynapsePostNeuronTransformer).
 

pynestml/codegeneration/nest_code_generator.py

@@ -593,7 +593,14 @@ def _get_synapse_model_namespace(self, synapse: ASTModel) -> Dict:
                 namespace["state_vars_that_need_continuous_buffering_transformed"] = [xfrm.get_neuron_var_name_from_syn_port_name(port_name, removesuffix(synapse.paired_neuron.unpaired_name, FrontendConfiguration.suffix), removesuffix(synapse.paired_neuron.paired_synapse.get_name().split("__with_")[0], FrontendConfiguration.suffix)) for port_name in synapse.paired_neuron.state_vars_that_need_continuous_buffering]
                 namespace["state_vars_that_need_continuous_buffering_transformed_iv"] = {}
                 for var_name, var_name_transformed in zip(namespace["state_vars_that_need_continuous_buffering"], namespace["state_vars_that_need_continuous_buffering_transformed"]):
-                    namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = self._nest_printer.print(synapse.paired_neuron.get_initial_value(var_name_transformed))
+                    if synapse.paired_neuron.get_initial_value(var_name_transformed) is None:
+                        if var_name_transformed in [sym.name for sym in synapse.paired_neuron.get_inline_expression_symbols()]:
+                            # the postsynaptic variable is actually an inline expression: initial value is 0
+                            namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = "0"
+                        else:
+                            raise Exception("State variable \"" + str(var_name_transformed) + "\" was not found in the neuron model \"" + synapse.paired_neuron.name + "\"")
+                    else:
+                        namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = self._nest_printer.print(synapse.paired_neuron.get_initial_value(var_name_transformed))
 
             namespace["continuous_post_ports"] = []
             if "neuron_synapse_pairs" in FrontendConfiguration.get_codegen_opts().keys():
@@ -711,9 +718,20 @@ def _get_neuron_model_namespace(self, neuron: ASTModel) -> Dict:
                 codegen_and_builder_opts = FrontendConfiguration.get_codegen_opts()
                 xfrm = SynapsePostNeuronTransformer(codegen_and_builder_opts)
                 namespace["state_vars_that_need_continuous_buffering_transformed"] = [xfrm.get_neuron_var_name_from_syn_port_name(port_name, removesuffix(neuron.unpaired_name, FrontendConfiguration.suffix), removesuffix(neuron.paired_synapse.get_name().split("__with_")[0], FrontendConfiguration.suffix)) for port_name in neuron.state_vars_that_need_continuous_buffering]
+                for i, item in enumerate(namespace["state_vars_that_need_continuous_buffering_transformed"]):
+                    if item is None:
+                        raise Exception("State variable \"" + str(neuron.state_vars_that_need_continuous_buffering[i]) + "\" was not found in the neuron model \"" + neuron.name + "\"")
+
                 namespace["state_vars_that_need_continuous_buffering_transformed_iv"] = {}
                 for var_name, var_name_transformed in zip(namespace["state_vars_that_need_continuous_buffering"], namespace["state_vars_that_need_continuous_buffering_transformed"]):
-                    namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = self._nest_printer.print(neuron.get_initial_value(var_name_transformed))
+                    if neuron.get_initial_value(var_name_transformed) is None:
+                        if var_name_transformed in [sym.name for sym in neuron.get_inline_expression_symbols()]:
+                            # the postsynaptic variable is actually an inline expression: initial value is 0
+                            namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = "0"
+                        else:
+                            raise Exception("State variable \"" + str(var_name_transformed) + "\" was not found in the neuron model \"" + neuron.name + "\"")
+                    else:
+                        namespace["state_vars_that_need_continuous_buffering_transformed_iv"][var_name] = self._nest_printer.print(neuron.get_initial_value(var_name_transformed))
             else:
                 namespace["state_vars_that_need_continuous_buffering"] = []
             if "extra_on_emit_spike_stmts_from_synapse" in dir(neuron):

pynestml/codegeneration/resources_genn/directives_cpp/BufferDeclarationValue.jinja2

@@ -0,0 +1 @@
+../../resources_nest/point_neuron/directives_cpp/MemberVariableGetter.jinja2

pynestml/codegeneration/resources_genn/directives_cpp/MemberVariableGetter.jinja2

@@ -0,0 +1 @@
+../../resources_nest/point_neuron/directives_cpp/MemberVariableSetter.jinja2

pynestml/codegeneration/resources_genn/directives_cpp/MemberVariableGetterSetter.jinja2

@@ -412,7 +412,8 @@ public:
 {%-         for variable_symbol in neuron.get_state_symbols() %}
 {%-             if not is_delta_kernel(neuron.get_kernel_by_name(variable_symbol.name)) %}
 {%-                 set variable = utils.get_state_variable_by_name(astnode, variable_symbol.get_symbol_name()) %}
-{%-                 include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-                 include "directives_cpp/MemberVariableGetter.jinja2" %}
+{%-                 include "directives_cpp/MemberVariableSetter.jinja2" %}
 {%              endif %}
 {%          endfor %}
 {%-     endfilter %}
@@ -426,7 +427,8 @@ public:
 {%      filter indent(2, True) -%}
 {%-         for variable_symbol in neuron.get_parameter_symbols() %}
 {%-             set variable = utils.get_parameter_variable_by_name(astnode, variable_symbol.get_symbol_name()) %}
-{%-             include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-             include "directives_cpp/MemberVariableGetter.jinja2" %}
+{%-             include "directives_cpp/MemberVariableSetter.jinja2" %}
 
 {%          endfor %}
 {%-     endfilter %}
@@ -440,7 +442,8 @@ public:
 {%      filter indent(2, True) -%}
 {%-         for variable_symbol in neuron.get_internal_symbols() %}
 {%-             with variable = utils.get_internal_variable_by_name(astnode, variable_symbol.get_symbol_name()) %}
-{%-                 include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-                 include "directives_cpp/MemberVariableGetter.jinja2" %}
+{%-                 include "directives_cpp/MemberVariableSetter.jinja2" %}
 {%-             endwith %}
 {%          endfor %}
 {%-     endfilter %}
@@ -878,15 +881,30 @@ private:
   };
 
   // -------------------------------------------------------------------------
-  //   Getters/setters for inline expressions
+  //   Getters for inline expressions
   // -------------------------------------------------------------------------
+public:
+{%  filter indent(2, True) -%}
+{%- for equations_block in neuron.get_equations_blocks() %}
+{%-     for inline_expr in equations_block.get_inline_expressions() %}
+{%-         set variable = ast_node_factory.create_ast_variable(inline_expr.get_variable_name(), differential_order=0, scope=inline_expr.scope) %}
+{%-         set variable_symbol = equations_block.get_scope().resolve_to_symbol(inline_expr.get_variable_name(), SymbolKind.VARIABLE) %}
+{%-         include "directives_cpp/MemberVariableGetter.jinja2" %}
 
+{%     endfor %}
+{%- endfor %}
+{%- endfilter %}
+
+  // -------------------------------------------------------------------------
+  //   Setters for inline expressions (this is allowed for expressions containing a convolve() call)
+  // -------------------------------------------------------------------------
+private:
 {%  filter indent(2, True) -%}
 {%- for equations_block in neuron.get_equations_blocks() %}
 {%-     for inline_expr in equations_block.get_inline_expressions() %}
 {%-         set variable = ast_node_factory.create_ast_variable(inline_expr.get_variable_name(), differential_order=0, scope=inline_expr.scope) %}
 {%-         set variable_symbol = equations_block.get_scope().resolve_to_symbol(inline_expr.get_variable_name(), SymbolKind.VARIABLE) %}
-{%-         include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-         include "directives_cpp/MemberVariableSetter.jinja2" %}
 
 {%     endfor %}
 {%- endfor %}

pynestml/codegeneration/resources_genn/directives_cpp/MemberVariableSetter.jinja2

@@ -428,7 +428,8 @@ private:
 {%-     set isHomogeneous = PyNestMLLexer["DECORATOR_HOMOGENEOUS"] in variable_symbol.get_decorators() %}
 {%-     if not isHomogeneous %}
 {%-         if variable.get_name() != nest_codegen_opt_delay_variable and variable.get_name() != synapse_weight_variable %}
-{%-             include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-             include "directives_cpp/MemberVariableGetter.jinja2" %}
+{%-             include "directives_cpp/MemberVariableSetter.jinja2" %}
 {%          elif variable.get_name() == synapse_weight_variable and variable.get_name() != "weight" %}
 {#              weight is its own special case in NEST #}
 inline {{ declarations.print_variable_type(variable_symbol) }} get_{{ variable.get_name() }}() const
@@ -454,7 +455,8 @@ inline void set_{{ variable.get_name() }}(const {{ declarations.print_variable_t
 {%-     for inline_expr in equations_block.get_inline_expressions() %}
 {%-         set variable = ast_node_factory.create_ast_variable(inline_expr.get_variable_name(), differential_order=0, scope=inline_expr.scope) %}
 {%-         set variable_symbol = equations_block.get_scope().resolve_to_symbol(variable.get_complete_name(), SymbolKind.VARIABLE) %}
-{%-         include "directives_cpp/MemberVariableGetterSetter.jinja2" %}
+{%-         include "directives_cpp/MemberVariableGetter.jinja2" %}
+{%-         include "directives_cpp/MemberVariableSetter.jinja2" %}
 {%-     endfor %}
 {%- endfor %}
 {%- endfilter %}
@@ -1082,9 +1084,11 @@ void
 
 {%- filter indent(4, True) %}
 {%-     set dynamics = synapse.get_on_receive_block(vt_port) %}
-{%-     with ast = dynamics.get_stmts_body() %}
-{%-         include "directives_cpp/StmtsBody.jinja2" %}
-{%-     endwith %}
+{%-     if dynamics is not none %}
+{%-         with ast = dynamics.get_stmts_body() %}
+{%-             include "directives_cpp/StmtsBody.jinja2" %}
+{%-         endwith %}
+{%-     endif %}
 {%- endfilter %}
     // process remaining dopa spikes in (t0, t1]
     double cd;
@@ -1102,9 +1106,11 @@ void
       **/
 {%- filter indent(6, True) %}
 {%-     set dynamics = synapse.get_on_receive_block(vt_port) %}
-{%-     with ast = dynamics.get_stmts_body() %}
-{%-         include "directives_cpp/StmtsBody.jinja2" %}
-{%-     endwith %}
+{%-     if dynamics is not none %}
+{%-         with ast = dynamics.get_stmts_body() %}
+{%-             include "directives_cpp/StmtsBody.jinja2" %}
+{%-         endwith %}
+{%-     endif %}
 {%- endfilter %}
 
       /**
@@ -1546,6 +1552,20 @@ inline void
     std::cout << "[synapse " << this << "] {{ synapseName }}::trigger_update_weight(): t = " << t_trig << std::endl;
 #endif
 
+  const size_t tid = kernel().vp_manager.get_thread_id();
+{%- if paired_neuron_name is not none and paired_neuron_name|length > 0 %}
+  {{ paired_neuron_name }}* __target = static_cast< {{ paired_neuron_name }}* >(get_target(tid));
+  assert(__target);
+{%- else %}
+  Node* __target = get_target( tid );
+{%- endif %}
+
+  auto get_t = [t_trig](){ return t_trig; };    // do not remove, this is in case the predefined time variable ``t`` is used in the NESTML model
+
+{%- if paired_neuron_name is not none and paired_neuron_name|length > 0 and paired_neuron.state_vars_that_need_continuous_buffering | length > 0 and continuous_state_buffering_method == "continuous_time_buffer" %}
+#error "For third-factor plasticity combining spiking and continuous-time inputs, \"continuous_time_buffer\" is not supported yet!"
+{%- endif %}
+
   // purely dendritic delay
   double dendritic_delay = get_delay();
 
@@ -1562,7 +1582,7 @@ inline void
   while ( start != finish )
   {
 {%- for vt_port in vt_ports %}
-{%- set vt_port = vt_ports[0] %}
+{%-     set vt_port = vt_ports[0] %}
     process_{{vt_port}}_spikes_( vt_spikes, t0, start->t_ + dendritic_delay, cp );
 {%- endfor %}
 
@@ -1574,6 +1594,20 @@ inline void
      * update synapse internal state from `t_last_update_` to `start->t_ + dendritic_delay`
     **/
 
+{%- if paired_neuron_name is not none and paired_neuron_name|length > 0 and paired_neuron.state_vars_that_need_continuous_buffering | length > 0 %}
+        /**
+         * grab state variables from the postsynaptic neuron at the time of the post spike
+        **/
+
+{#- post spike based: grab the entry from the post spiking history buffer #}
+{%-     if continuous_state_buffering_method == "post_spike_based" %}
+{%-         for var_name in paired_neuron.state_vars_that_need_continuous_buffering %}
+{%-         set var_name_post = utils.get_var_name_tuples_of_neuron_synapse_pair(continuous_post_ports, var_name) %}
+        const double __{{ var_name }} = start->{{ var_name }}_;
+{%-         endfor %}
+{%-     endif %}
+{%- endif %}
+
     update_internal_state_(t_last_update_,
                            (start->t_ + dendritic_delay) - t_last_update_,
                            cp);
@@ -1609,7 +1643,7 @@ inline void
   **/
 
 {%- for vt_port in vt_ports %}
-{%- set vt_port = vt_ports[0] %}
+{%-     set vt_port = vt_ports[0] %}
   process_{{vt_port}}_spikes_( vt_spikes, t_lastspike_, t_trig, cp );
 {%- endfor %}
 #ifdef DEBUG

pynestml/codegeneration/resources_nest/point_neuron/common/NeuronHeader.jinja2

@@ -8,9 +8,4 @@ inline {{ declarations.print_variable_type(variable_symbol) }} get_{{ printer_no
 {
   return {{ nest_codegen_utils.print_symbol_origin(variable_symbol, variable) % printer_no_origin.print(variable) }};
 }
-
-inline void set_{{ printer_no_origin.print(variable) }}(const {{ declarations.print_variable_type(variable_symbol) }} __v)
-{
-  {{ nest_codegen_utils.print_symbol_origin(variable_symbol, variable) % printer_no_origin.print(variable) }} = __v;
-}
 {%- endif %}

pynestml/codegeneration/resources_nest/point_neuron/common/SynapseHeader.h.jinja2

@@ -0,0 +1,6 @@
+{% if not (variable_symbol.is_inline_expression and not utils.contains_convolve_call(variable_symbol)) -%}
+inline void set_{{ printer_no_origin.print(variable) }}(const {{ declarations.print_variable_type(variable_symbol) }} __v)
+{
+  {{ nest_codegen_utils.print_symbol_origin(variable_symbol, variable) % printer_no_origin.print(variable) }} = __v;
+}
+{%- endif %}