synapse_types.h File Reference

API for synaptic behaviour types (see also src/neuron/input_types) More...

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

Go to the source code of this file.

Functions
static void	synapse_types_initialise (synapse_types_t *state, synapse_types_params_t *params, uint32_t n_steps_per_time_step)
	initialise the structure from the parameters
static void	synapse_types_save_state (synapse_types_t *state, synapse_types_params_t *params)
	save parameters and state back to SDRAM for reading by host and recovery on restart
static void	synapse_types_shape_input (synapse_types_t *parameters)
	decays the stuff thats sitting in the input buffers as these have not yet been processed and applied to the neuron.
static void	synapse_types_add_neuron_input (index_t synapse_type_index, synapse_types_t *parameters, input_t input)
	adds the inputs for a give timer period to a given neuron that is being simulated by this model
static input_t *	synapse_types_get_excitatory_input (input_t *excitatory_response, synapse_types_t *parameters)
	extracts the excitatory input buffers from the buffers available for a given neuron ID
static input_t *	synapse_types_get_inhibitory_input (input_t *inhibitory_response, synapse_types_t *parameters)
	extracts the inhibitory input buffers from the buffers available for a given neuron ID
static const char *	synapse_types_get_type_char (index_t synapse_type_index)
	returns a human readable character for the type of synapse.
static void	synapse_types_print_parameters (synapse_types_t *parameters)
	prints the parameters of the synapse type
static void	synapse_types_print_input (synapse_types_t *parameters)
	prints the input for a neuron ID given the available inputs currently only executed when the models are in debug mode, as the prints are controlled from the synapses.c print_inputs() method.

Detailed Description

API for synaptic behaviour types (see also src/neuron/input_types)

Definition in file synapse_types.h.

Function Documentation

synapse_types_initialise()

static void synapse_types_initialise ( synapse_types_t *  state, synapse_types_params_t *  params, uint32_t  n_steps_per_time_step  )

static

initialise the structure from the parameters

Parameters

[out]	state	Pointer to the state to set up
[in]	params	Pointer to the parameters passed in from host
[in]	n_steps_per_timestep	The number of steps to run each update

synapse_types_save_state()

static void synapse_types_save_state ( synapse_types_t *  state, synapse_types_params_t *  params  )

static

save parameters and state back to SDRAM for reading by host and recovery on restart

Parameters

[in]	state	The current state
[out]	params	Pointer to structure into which parameter can be written

synapse_types_shape_input()

static void synapse_types_shape_input ( synapse_types_t *  parameters )

static

decays the stuff thats sitting in the input buffers as these have not yet been processed and applied to the neuron.

This is to compensate for the valve behaviour of a synapse in biology (spike goes in, synapse opens, then closes slowly).

Parameters

[in,out]

parameters

the parameters to update

synapse_types_add_neuron_input()

static void synapse_types_add_neuron_input ( index_t  synapse_type_index, synapse_types_t *  parameters, input_t  input  )

static

adds the inputs for a give timer period to a given neuron that is being simulated by this model

Parameters

[in]	synapse_type_index	the type of input that this input is to be considered (aka excitatory or inhibitory etc)
[in,out]	parameters	the parameters to update
[in]	input	the inputs for that given synapse_type.

synapse_types_get_excitatory_input()

static input_t * synapse_types_get_excitatory_input ( input_t *  excitatory_response, synapse_types_t *  parameters  )

static

extracts the excitatory input buffers from the buffers available for a given neuron ID

Parameters

[in,out]	excitatory_response	Buffer to put response in
[in]	parameters	the pointer to the parameters to use

Returns

Pointer to array of excitatory input buffers for a given neuron ID.

synapse_types_get_inhibitory_input()

static input_t * synapse_types_get_inhibitory_input ( input_t *  inhibitory_response, synapse_types_t *  parameters  )

static

extracts the inhibitory input buffers from the buffers available for a given neuron ID

Parameters

[in,out]	inhibitory_response	Buffer to put response in
[in]	parameters	the pointer to the parameters to use

Returns

Pointer to array of inhibitory input buffers for a given neuron ID.

synapse_types_get_type_char()

static const char * synapse_types_get_type_char ( index_t  synapse_type_index )

static

returns a human readable character for the type of synapse.

Examples would be X = excitatory types, I = inhibitory types, etc.

Parameters

[in]

synapse_type_index

the synapse type index (there is a specific index interpretation in each synapse type)

Returns

a human readable character representing the synapse type.

synapse_types_print_parameters()

static void synapse_types_print_parameters ( synapse_types_t *  parameters )

static

prints the parameters of the synapse type

Parameters

[in]

parameters

the pointer to the parameters to print

synapse_types_print_input()

static void synapse_types_print_input ( synapse_types_t *  parameters )

static

prints the input for a neuron ID given the available inputs currently only executed when the models are in debug mode, as the prints are controlled from the synapses.c print_inputs() method.

Parameters

[in]

parameters

the pointer to the parameters to print