synapse_dynamics.h File Reference

API for synapse dynamics. More...

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

Go to the source code of this file.

Functions
bool	synapse_dynamics_initialise (address_t address, uint32_t n_neurons, uint32_t n_synapse_types, uint32_t *ring_buffer_to_input_buffer_left_shifts)
	Initialise the synapse dynamics.
bool	synapse_dynamics_process_plastic_synapses (synapse_row_plastic_data_t *plastic_region_data, synapse_row_fixed_part_t *fixed_region, weight_t *ring_buffers, uint32_t time, uint32_t colour_delay, bool *write_back)
	Process the dynamics of the synapses.
void	synapse_dynamics_process_post_synaptic_event (uint32_t time, index_t neuron_index)
	Inform the synapses that the neuron fired.
void	synapse_dynamics_print_plastic_synapses (synapse_row_plastic_data_t *plastic_region_data, synapse_row_fixed_part_t *fixed_region, uint32_t *ring_buffer_to_input_buffer_left_shifts)
	Print the synapse dynamics.
uint32_t	synapse_dynamics_get_plastic_pre_synaptic_events (void)
	Get the counters for plastic pre synaptic events based on (if the model was compiled with SYNAPSE_BENCHMARK parameter) or returns 0.
uint32_t	synapse_dynamics_get_plastic_saturation_count (void)
	Get the number of ring buffer saturation events due to adding plastic weights.
bool	synapse_dynamics_find_neuron (uint32_t id, synaptic_row_t row, weight_t *weight, uint16_t *delay, uint32_t *offset, uint32_t *synapse_type)
	Search the synaptic row for the the connection with the specified post-synaptic ID.
bool	synapse_dynamics_remove_neuron (uint32_t offset, synaptic_row_t row)
	Remove the entry at the specified offset in the synaptic row.
bool	synapse_dynamics_add_neuron (uint32_t id, synaptic_row_t row, weight_t weight, uint32_t delay, uint32_t type)
	Add an entry in the synaptic row.
uint32_t	synapse_dynamics_n_connections_in_row (synapse_row_fixed_part_t *fixed)
	Get the number of connections in the given row.

Detailed Description

API for synapse dynamics.

Definition in file synapse_dynamics.h.

Function Documentation

synapse_dynamics_initialise()

bool synapse_dynamics_initialise	(	address_t	address,
		uint32_t	n_neurons,
		uint32_t	n_synapse_types,
		uint32_t *	ring_buffer_to_input_buffer_left_shifts
	)

Initialise the synapse dynamics.

Parameters

[in]	address	Where the configuration data is
[in]	n_neurons	Number of neurons
[in]	n_synapse_types	Number of synapse types
[in]	ring_buffer_to_input_buffer_left_shifts	How to interpret the values from the ring buffers

Returns

Whether the initialisation succeeded.

Definition at line 276 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_process_plastic_synapses()

bool synapse_dynamics_process_plastic_synapses	(	synapse_row_plastic_data_t *	plastic_region_data,
		synapse_row_fixed_part_t *	fixed_region,
		weight_t *	ring_buffers,
		uint32_t	time,
		uint32_t	colour_delay,
		bool *	write_back
	)

Process the dynamics of the synapses.

Parameters

[in,out]	plastic_region_data	Where the plastic data is
[in]	fixed_region	Where the fixed data is
[in,out]	ring_buffers	The ring buffers
[in]	time	The current simulation time
[out]	Whether	to write back anything

Returns

Whether the processing was successful or not

Definition at line 460 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_process_post_synaptic_event()

void synapse_dynamics_process_post_synaptic_event	(	uint32_t	time,
		index_t	neuron_index
	)

Inform the synapses that the neuron fired.

Parameters

[in]	time	The current simulation time
[in]	neuron_index	Which neuron are we processing

Definition at line 109 of file c_main_local_only.c.

synapse_dynamics_print_plastic_synapses()

void synapse_dynamics_print_plastic_synapses	(	synapse_row_plastic_data_t *	plastic_region_data,
		synapse_row_fixed_part_t *	fixed_region,
		uint32_t *	ring_buffer_to_input_buffer_left_shifts
	)

Print the synapse dynamics.

Parameters

[in]	plastic_region_data	Where the plastic data is
[in]	fixed_region	Where the fixed data is
[in]	ring_buffer_to_input_buffer_left_shifts	How to interpret the values from the ring buffers

Definition at line 315 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_get_plastic_pre_synaptic_events()

uint32_t synapse_dynamics_get_plastic_pre_synaptic_events

(

void

)

Get the counters for plastic pre synaptic events based on (if the model was compiled with SYNAPSE_BENCHMARK parameter) or returns 0.

Returns

counters for plastic pre synaptic events or 0

Definition at line 146 of file synapse_dynamics_stdp_common.h.

synapse_dynamics_get_plastic_saturation_count()

uint32_t synapse_dynamics_get_plastic_saturation_count

(

void

)

Get the number of ring buffer saturation events due to adding plastic weights.

Returns

counter for saturation events or 0

Definition at line 150 of file synapse_dynamics_stdp_common.h.

synapse_dynamics_find_neuron()

bool synapse_dynamics_find_neuron	(	uint32_t	id,
		synaptic_row_t	row,
		weight_t *	weight,
		uint16_t *	delay,
		uint32_t *	offset,
		uint32_t *	synapse_type
	)

Search the synaptic row for the the connection with the specified post-synaptic ID.

Parameters

[in]	id	the (core-local) ID of the neuron to search for in the synaptic row
[in]	row	the core-local address of the synaptic row
[out]	weight	address to contain the weight of the connection
[out]	delay	address to contain the delay of the connection
[out]	offset	address to contain the offset of the connection
[out]	synapse_type	the synapse type of the connection

Returns

was the search successful?

Definition at line 512 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_remove_neuron()

bool synapse_dynamics_remove_neuron	(	uint32_t	offset,
		synaptic_row_t	row
	)

Remove the entry at the specified offset in the synaptic row.

Parameters

[in]	offset	the offset in the row at which to remove the entry
[in]	row	the core-local address of the synaptic row

Returns

was the removal successful?

Definition at line 542 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_add_neuron()

bool synapse_dynamics_add_neuron	(	uint32_t	id,
		synaptic_row_t	row,
		weight_t	weight,
		uint32_t	delay,
		uint32_t	type
	)

Add an entry in the synaptic row.

Parameters

[in]	id	the (core-local) ID of the post-synaptic neuron to be added
[in]	row	the core-local address of the synaptic row
[in]	weight	the initial weight associated with the connection
[in]	delay	the delay associated with the connection
[in]	type	the type of the connection (e.g. inhibitory)

Returns

was the addition successful?

Definition at line 560 of file synapse_dynamics_stdp_izhikevich_neuromodulation.c.

synapse_dynamics_n_connections_in_row()

uint32_t synapse_dynamics_n_connections_in_row

(

synapse_row_fixed_part_t *

fixed

)

Get the number of connections in the given row.

Parameters

[in]

fixed

the fixed region of the synaptic row

Returns

The number of connections in the row

Definition at line 201 of file synapse_dynamics_stdp_common.h.