synapses.h File Reference

Operations on synapses. More...

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

Go to the source code of this file.

Functions
static void	synapses_print_weight (weight_t weight, uint32_t left_shift)
	Print the weight of a synapse.
bool	synapses_initialise (address_t synapse_params_address, uint32_t *n_neurons, uint32_t *n_synapse_types, weight_t **ring_buffers, uint32_t **ring_buffer_to_input_buffer_left_shifts, bool *clear_input_buffers_of_late_packets_init, uint32_t *incoming_spike_buffer_size)
	Initialise the synapse processing.
bool	synapses_process_synaptic_row (uint32_t time, uint32_t spike_colour, uint32_t colour_mask, synaptic_row_t row, bool *write_back)
	process a synaptic row
uint32_t	synapses_get_pre_synaptic_events (void)
	returns the counters for plastic and fixed pre synaptic events based on (if the model was compiled with SYNAPSE_BENCHMARK parameter) or returns 0
void	synapses_resume (timer_t time)
	Resume processing of synapses after a pause.
void	synapses_flush_ring_buffers (timer_t time)
	Reset the ring buffers to 0 at the given time.

Variables
uint32_t	synapse_type_index_bits
	Number of bits needed for the synapse type and index.
uint32_t	synapse_type_index_mask
	Mask to pick out the synapse type and index.
uint32_t	synapse_index_bits
	Number of bits in the synapse index.
uint32_t	synapse_index_mask
	Mask to pick out the synapse index.
uint32_t	synapse_type_bits
	Number of bits in the synapse type.
uint32_t	synapse_type_mask
	Mask to pick out the synapse type.
uint32_t	synapse_delay_bits
	Number of bits in the delay.
uint32_t	synapse_delay_mask
	Mask to pick out the delay.
uint32_t	synapses_saturation_count
	Count of the number of times the synapses have saturated their weights.
uint32_t	skipped_synapses
uint32_t	late_spikes
	Count of the spikes that are received late.
uint32_t	max_late_spike
	The maximum lateness of a spike.

Detailed Description

Operations on synapses.

Definition in file synapses.h.

Function Documentation

synapses_print_weight()

static void synapses_print_weight ( weight_t  weight, uint32_t  left_shift  )

inlinestatic

Print the weight of a synapse.

Parameters

[in]	weight	the weight to print in synapse-row form
[in]	left_shift	the shift to use when decoding

Definition at line 68 of file synapses.h.

synapses_initialise()

bool synapses_initialise	(	address_t	synapse_params_address,
		uint32_t *	n_neurons,
		uint32_t *	n_synapse_types,
		weight_t **	ring_buffers,
		uint32_t **	ring_buffer_to_input_buffer_left_shifts,
		bool *	clear_input_buffers_of_late_packets_init,
		uint32_t *	incoming_spike_buffer_size
	)

Initialise the synapse processing.

Parameters

[in]	synapse_params_address	Synapse configuration in SDRAM
[out]	n_neurons	Number of neurons that will be simulated
[out]	n_synapse_types	Number of synapse types that will be simulated
[out]	ring_buffers	The ring buffers that will be used
[out]	ring_buffer_to_input_buffer_left_shifts	Array of shifts to use when converting from ring buffer values to input buffer values
[out]	clear_input_buffers_of_late_packets_init	Inicates whether to clear the input buffers each time step
[out]	incoming_spike_buffer_size	The number of spikes to support in the incoming spike circular buffer

Returns

True if successfully initialised. False otherwise.

Definition at line 269 of file synapses.c.

synapses_process_synaptic_row()

bool synapses_process_synaptic_row	(	uint32_t	time,
		uint32_t	spike_colour,
		uint32_t	colour_mask,
		synaptic_row_t	row,
		bool *	write_back
	)

process a synaptic row

Parameters

[in]	time	the simulated time
[in]	spike_colour	the colour extracted from the spike key
[in]	colour_mask	the colour mask extracted from the pop table
[in]	row	the synaptic row in question
[out]	write_back	whether to write back to SDRAM

Returns

True if successful

Definition at line 352 of file synapses.c.

synapses_get_pre_synaptic_events()

uint32_t synapses_get_pre_synaptic_events

(

void

)

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

Returns

the counter for plastic and fixed pre synaptic events or 0

Definition at line 406 of file synapses.c.

synapses_resume()

void synapses_resume

(

timer_t

time

)

Resume processing of synapses after a pause.

Parameters

[in]

time

The time at which the simulation is to start

Definition at line 411 of file synapses.c.

synapses_flush_ring_buffers()

void synapses_flush_ring_buffers

(

timer_t

time

)

Reset the ring buffers to 0 at the given time.

Parameters

[in]

time

the simulated time to reset the buffers at

Definition at line 337 of file synapses.c.

Variable Documentation

synapse_type_index_bits

uint32_t synapse_type_index_bits

extern

Number of bits needed for the synapse type and index.

synapse_index_bits + synapse_type_bits

Number of bits needed for the synapse type and index.

The number of bits used by the synapse type and post-neuron index.

synapse_index_bits + synapse_type_bits

Definition at line 74 of file local_only.c.

synapse_type_index_mask

uint32_t synapse_type_index_mask

extern

Mask to pick out the synapse type and index.

synapse_index_mask | synapse_type_mask

Definition at line 65 of file synapses.c.

synapse_index_bits

uint32_t synapse_index_bits

extern

Number of bits in the synapse index.

Number of bits in the synapse index.

The number of bits used by just the post-neuron index.

Definition at line 77 of file local_only.c.

synapse_index_mask

uint32_t synapse_index_mask

extern

Mask to pick out the synapse index.

Definition at line 69 of file synapses.c.

synapse_type_bits

uint32_t synapse_type_bits

extern

Number of bits in the synapse type.

Definition at line 71 of file synapses.c.

synapse_type_mask

uint32_t synapse_type_mask

extern

Mask to pick out the synapse type.

Definition at line 73 of file synapses.c.

synapse_delay_bits

uint32_t synapse_delay_bits

extern

Number of bits in the delay.

Definition at line 75 of file synapses.c.

synapse_delay_mask

uint32_t synapse_delay_mask

extern

Mask to pick out the delay.

Mask to pick out the delay.

The mask to get the synaptic delay from a "synapse".

Definition at line 71 of file local_only.c.

synapses_saturation_count

uint32_t synapses_saturation_count

extern

Count of the number of times the synapses have saturated their weights.

Count of the number of times the synapses have saturated their weights.

Definition at line 80 of file synapses.c.

skipped_synapses

uint32_t skipped_synapses

extern

Count of the synapses that have been skipped because the delay wasn't big enough given how long the spike took to arrive

Definition at line 84 of file synapses.c.

late_spikes

uint32_t late_spikes

extern

Count of the spikes that are received late.

Definition at line 87 of file synapses.c.

max_late_spike

uint32_t max_late_spike

extern

The maximum lateness of a spike.

Definition at line 90 of file synapses.c.