interface for neurons
More...
#include "synapse_row.h"
#include <common/neuron-typedefs.h>
#include <spin1_api.h>
Go to the source code of this file.
interface for neurons
The API contains:
- neuron_initialise(): translate the data stored in the NEURON_PARAMS data region in SDRAM and converts it into C-based objects for use.
- neuron_set_input_buffers(input_buffers_value): setter for the internal input buffers
- neuron_do_timestep_update(): executes all the updates to neural parameters when a given timer period has occurred.
Definition in file neuron.h.
◆ neuron_initialise()
| bool neuron_initialise |
( |
void * |
core_params_address, |
|
|
void * |
neuron_params_address, |
|
|
void * |
current_sources_address, |
|
|
void * |
recording_address, |
|
|
void * |
initial_values_address, |
|
|
uint32_t * |
n_rec_regions_used |
|
) |
| |
translate the data stored in the NEURON_PARAMS data region in SDRAM and convert it into c based objects for use.
- Parameters
-
| [in] | core_params_address | the absolute address in SDRAM for the start of the core parameters data region in SDRAM |
| [in] | neuron_params_address | The absolute address in SDRAM for the start of the neuron parameters data region in SDRAM |
| [in] | current_sources_address | The absolute address in SDRAM for the start of the current sources data region in SDRAM |
| [in] | recording_address | the recording parameters in SDRAM (contains which regions are active and how big they are) |
| [in] | initial_values_address | The address where initial values can be written to for later reading. |
| [out] | n_rec_regions_used | The number of regions used by neuron recording |
- Returns
- True if the translation was successful, otherwise False
Definition at line 105 of file neuron.c.
◆ neuron_do_timestep_update()
| void neuron_do_timestep_update |
( |
timer_t |
time, |
|
|
uint |
timer_count |
|
) |
| |
executes all the updates to neural parameters when a given timer period has occurred.
- Parameters
-
| [in] | time | the timer tick value currently being executed |
| [in] | timer_count | used for detecting a wrapping timer |
Definition at line 190 of file neuron.c.
◆ neuron_resume()
| bool neuron_resume |
( |
uint32_t |
time | ) |
|
Prepare to resume simulation of the neurons.
- Parameters
-
| [in] | time | The time of the resume |
- Returns
- bool which is true if the resume was successful or not
Definition at line 93 of file neuron.c.
◆ neuron_pause()
| void neuron_pause |
( |
void |
| ) |
|
Perform steps needed before pausing a simulation.
Stores neuron parameters back into SDRAM.
Definition at line 184 of file neuron.c.
◆ neuron_transfer()
| void neuron_transfer |
( |
weight_t * |
syns | ) |
|
Add inputs to the neurons.
- Parameters
-
| [in] | syns | The inputs to be added; this is an array of size n_synapse_types * 2^ceil(log_2(n_neurons)). |
Definition at line 204 of file neuron.c.
◆ neuron_print_inputs()
| void neuron_print_inputs |
( |
void |
| ) |
|
Print the inputs to the neurons.
Only available in debug mode.
Definition at line 230 of file neuron.c.
◆ neuron_print_synapse_parameters()
| void neuron_print_synapse_parameters |
( |
void |
| ) |
|
Print the neurons' synapse parameters.
Only available in debug mode.
Definition at line 234 of file neuron.c.
◆ neuron_get_synapse_type_char()
| const char* neuron_get_synapse_type_char |
( |
uint32_t |
synapse_type | ) |
|
Get the synapse type description character.
Only available in debug mode.
- Parameters
-
| [in] | synapse_type | The synapse type. |
- Returns
- a single character that describes the synapse.
Definition at line 238 of file neuron.c.
