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

The API for neuron models themselves. More...

#include <common/neuron-typedefs.h>
#include <debug.h>

Go to the source code of this file.

Functions

static void neuron_model_initialise (neuron_t *state, neuron_params_t *params, uint32_t n_steps_per_timestep)
 initialise the structure from the parameters More...
 
static void neuron_model_save_state (neuron_t *state, neuron_params_t *params)
 save parameters and state back to SDRAM for reading by host and recovery on restart More...
 
static state_t neuron_model_state_update (uint16_t num_excitatory_inputs, const input_t *exc_input, uint16_t num_inhibitory_inputs, const input_t *inh_input, input_t external_bias, REAL current_offset, neuron_t *restrict neuron)
 primary function called in timer loop after synaptic updates More...
 
static void neuron_model_has_spiked (neuron_t *restrict neuron)
 Indicates that the neuron has spiked. More...
 
static state_t neuron_model_get_membrane_voltage (const neuron_t *neuron)
 get the neuron membrane voltage for a given neuron parameter set More...
 
static void neuron_model_print_state_variables (const neuron_t *neuron)
 printout of state variables i.e. those values that might change More...
 
static void neuron_model_print_parameters (const neuron_t *neuron)
 printout of parameters i.e. those values that don't change More...
 

Detailed Description

The API for neuron models themselves.

Definition in file neuron_model.h.

Function Documentation

◆ neuron_model_initialise()

static void neuron_model_initialise ( neuron_t state,
neuron_params_t params,
uint32_t  n_steps_per_timestep 
)
static

initialise the structure from the parameters

Parameters
[out]statePointer to the state to be filled in
[in]paramsPointer to the parameters passed in from host
[in]n_steps_per_timestepNumber of time steps to be done each full update

◆ neuron_model_save_state()

static void neuron_model_save_state ( neuron_t state,
neuron_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

◆ neuron_model_state_update()

static state_t neuron_model_state_update ( uint16_t  num_excitatory_inputs,
const input_t exc_input,
uint16_t  num_inhibitory_inputs,
const input_t inh_input,
input_t  external_bias,
REAL  current_offset,
neuron_t *restrict  neuron 
)
static

primary function called in timer loop after synaptic updates

Parameters
[in]num_excitatory_inputsNumber of excitatory receptor types.
[in]exc_inputPointer to array of inputs per receptor type received this timer tick that produce a positive reaction within the neuron in terms of stimulation.
[in]num_inhibitory_inputsNumber of inhibitory receptor types.
[in]inh_inputPointer to array of inputs per receptor type received this timer tick that produce a negative reaction within the neuron in terms of stimulation.
[in]external_biasThis is the intrinsic plasticity which could be used for ac, noisy input etc etc. (general purpose input)
[in,out]neuronthe pointer to a neuron parameter struct which contains all the parameters for a specific neuron
Returns
the value to be compared with a threshold value to determine if the neuron has spiked

◆ neuron_model_has_spiked()

static void neuron_model_has_spiked ( neuron_t *restrict  neuron)
static

Indicates that the neuron has spiked.

Parameters
[in,out]neuronpointer to a neuron parameter struct which contains all the parameters for a specific neuron

◆ neuron_model_get_membrane_voltage()

static state_t neuron_model_get_membrane_voltage ( const neuron_t neuron)
static

get the neuron membrane voltage for a given neuron parameter set

Parameters
[in]neurona pointer to a neuron parameter struct which contains all the parameters for a specific neuron
Returns
the membrane voltage for a given neuron with the neuron parameters specified in neuron

◆ neuron_model_print_state_variables()

static void neuron_model_print_state_variables ( const neuron_t neuron)
static

printout of state variables i.e. those values that might change

Parameters
[in]neurona pointer to a neuron parameter struct which contains all the parameters for a specific neuron

◆ neuron_model_print_parameters()

static void neuron_model_print_parameters ( const neuron_t neuron)
static

printout of parameters i.e. those values that don't change

Parameters
[in]neurona pointer to a neuron parameter struct which contains all the parameters for a specific neuron