sPyNNaker neural_modelling 7.1.1
Loading...
Searching...
No Matches
Functions
additional_input.h File Reference

API for additional inputs. More...

#include <common/neuron-typedefs.h>

Go to the source code of this file.

Functions

static void additional_input_initialise (additional_input_t *state, additional_input_params_t *params, uint32_t n_steps_per_timestep)
 initialise the structure from the parameters
 
static void additional_input_save_state (additional_input_t *state, additional_input_params_t *params)
 save parameters and state back to SDRAM for reading by host and recovery on restart
 
static input_t additional_input_get_input_value_as_current (struct additional_input_t *additional_input, state_t membrane_voltage)
 Gets the value of current provided by the additional input this timestep.
 
static void additional_input_has_spiked (struct additional_input_t *additional_input)
 Notifies the additional input type that the neuron has spiked.
 

Detailed Description

API for additional inputs.

Definition in file additional_input.h.

Function Documentation

◆ additional_input_initialise()

static void additional_input_initialise ( additional_input_t state,
additional_input_params_t params,
uint32_t  n_steps_per_timestep 
)
static

initialise the structure from the parameters

Parameters
[out]statePointer to the state to be set up
[in]paramsPointer to the parameters passed in from host
[in]n_steps_per_timestepThe number of steps to run each update

◆ additional_input_save_state()

static void additional_input_save_state ( additional_input_t state,
additional_input_params_t params 
)
static

save parameters and state back to SDRAM for reading by host and recovery on restart

Parameters
[in]stateThe current state
[out]paramsPointer to structure into which parameter can be written

◆ additional_input_get_input_value_as_current()

static input_t additional_input_get_input_value_as_current ( struct additional_input_t additional_input,
state_t  membrane_voltage 
)
static

Gets the value of current provided by the additional input this timestep.

Parameters
[in]additional_inputThe additional input type pointer to the parameters
[in]membrane_voltageThe membrane voltage of the neuron
Returns
The value of the input after scaling

◆ additional_input_has_spiked()

static void additional_input_has_spiked ( struct additional_input_t additional_input)
static

Notifies the additional input type that the neuron has spiked.

Parameters
[in]additional_inputThe additional input type pointer to the parameters