neuron_impl.h File Reference

General API of a neuron implementation. More...

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

Go to the source code of this file.

Functions
static bool	neuron_impl_initialise (uint32_t n_neurons)
	Initialise the particular implementation of the data.
static void	neuron_impl_add_inputs (index_t synapse_type_index, index_t neuron_index, input_t weights_this_timestep)
	Add inputs to the neuron.
static void	neuron_impl_load_neuron_parameters (address_t address, uint32_t next, uint32_t n_neurons, address_t save_initial_state)
	Load in the neuron parameters.
static void	neuron_impl_do_timestep_update (uint32_t timer_count, uint32_t time, uint32_t n_neurons)
	Do the timestep update for the particular implementation.
static void	neuron_impl_store_neuron_parameters (address_t address, uint32_t next, uint32_t n_neurons)
	Stores neuron parameters back into SDRAM.
static void	neuron_impl_print_inputs (uint32_t n_neurons)
	Print the inputs to the neurons.
static void	neuron_impl_print_synapse_parameters (uint32_t n_neurons)
	Print the synapse parameters of the neurons.
static const char *	neuron_impl_get_synapse_type_char (uint32_t synapse_type)
	Get the synapse type character for a synapse type.

Detailed Description

General API of a neuron implementation.

Definition in file neuron_impl.h.

Function Documentation

neuron_impl_initialise()

static bool neuron_impl_initialise ( uint32_t  n_neurons )

static

Initialise the particular implementation of the data.

Parameters

[in]

n_neurons

The number of neurons

Returns

True if successful

neuron_impl_add_inputs()

static void neuron_impl_add_inputs ( index_t  synapse_type_index, index_t  neuron_index, input_t  weights_this_timestep  )

static

Add inputs to the neuron.

Parameters

[in]	synapse_type_index	the synapse type (e.g. exc. or inh.)
[in]	neuron_index	the index of the neuron
[in]	weights_this_timestep	weight inputs to be added

neuron_impl_load_neuron_parameters()

static void neuron_impl_load_neuron_parameters ( address_t  address, uint32_t  next, uint32_t  n_neurons, address_t  save_initial_state  )

static

Load in the neuron parameters.

Parameters

[in]	address	SDRAM block to read parameters from
[in]	next	Offset of next address in store
[in]	n_neurons	The number of neurons
[in]	save_initial_state	If not 0, the address to copy the state to

neuron_impl_do_timestep_update()

static void neuron_impl_do_timestep_update ( uint32_t  timer_count, uint32_t  time, uint32_t  n_neurons  )

static

Do the timestep update for the particular implementation.

Parameters

[in]	timer_count	The timer count, used for TDMA packet spreading
[in]	time	The time step of the update
[in]	n_neurons	The number of neurons

neuron_impl_store_neuron_parameters()

static void neuron_impl_store_neuron_parameters ( address_t  address, uint32_t  next, uint32_t  n_neurons  )

static

Stores neuron parameters back into SDRAM.

Parameters

[out]	address	the address in SDRAM to start the store
[in]	next	Offset of next address in store
[in]	n_neurons	The number of neurons

neuron_impl_print_inputs()

static void neuron_impl_print_inputs ( uint32_t  n_neurons )

static

Print the inputs to the neurons.

Parameters

[in]

n_neurons

The number of neurons

Definition at line 387 of file neuron_impl_external_devices.h.

neuron_impl_print_synapse_parameters()

static void neuron_impl_print_synapse_parameters ( uint32_t  n_neurons )

static

Print the synapse parameters of the neurons.

Parameters

[in]

n_neurons

The number of neurons

Definition at line 417 of file neuron_impl_external_devices.h.

neuron_impl_get_synapse_type_char()

static const char * neuron_impl_get_synapse_type_char ( uint32_t  synapse_type )

static

Get the synapse type character for a synapse type.

Parameters

[in]

synapse_type

The synapse type

Returns

The descriptor character (sometimes two characters)

Definition at line 427 of file neuron_impl_external_devices.h.