input_type.h File Reference

API for synaptic inputs (see also src/neuron/synapse_types) More...

#include <common/neuron-typedefs.h>

Go to the source code of this file.

Macros
#define	NUM_EXCITATORY_RECEPTORS   1
	The number of excitatory receptors. More...
#define	NUM_INHIBITORY_RECEPTORS   1
	The number of inhibitory receptors. More...

Functions
static void	input_type_initialise (input_type_t *state, input_type_params_t *params, uint32_t n_steps_per_timestep)
	initialise the structure from the parameters More...
static void	input_type_save_state (input_type_t *state, input_type_params_t *params)
	save parameters and state back to SDRAM for reading by host and recovery on restart More...
static input_t *	input_type_get_input_value (input_t *restrict value, input_type_t *input_type, uint16_t num_receptors)
	Gets the actual input value. This allows any scaling to take place. More...
static void	input_type_convert_excitatory_input_to_current (input_t *restrict exc_input, const input_type_t *input_type, state_t membrane_voltage)
	Converts an excitatory input into an excitatory current. More...
static void	input_type_convert_inhibitory_input_to_current (input_t *restrict inh_input, const input_type_t *input_type, state_t membrane_voltage)
	Converts an inhibitory input into an inhibitory current. More...

Detailed Description

API for synaptic inputs (see also src/neuron/synapse_types)

Definition in file input_type.h.

Macro Definition Documentation

NUM_EXCITATORY_RECEPTORS

#define NUM_EXCITATORY_RECEPTORS   1

The number of excitatory receptors.

It should be defined by a synapse shaping include.

Definition at line 28 of file input_type.h.

NUM_INHIBITORY_RECEPTORS

#define NUM_INHIBITORY_RECEPTORS   1

The number of inhibitory receptors.

It should be defined by a synapse shaping include.

Definition at line 37 of file input_type.h.

Function Documentation

input_type_initialise()

static void input_type_initialise ( input_type_t *  state, input_type_params_t *  params, uint32_t  n_steps_per_timestep  )

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 perform each update

input_type_save_state()

static void input_type_save_state ( input_type_t *  state, input_type_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

input_type_get_input_value()

static input_t * input_type_get_input_value ( input_t *restrict  value, input_type_t *  input_type, uint16_t  num_receptors  )

static

Gets the actual input value. This allows any scaling to take place.

Parameters

[in,out]	value	The array of the receptor-based values of the input before scaling
[in]	input_type	The input type pointer to the parameters
[in]	num_receptors	The number of receptors. The size of the value array.

Returns

Pointer to array of values of the receptor-based input after scaling

input_type_convert_excitatory_input_to_current()

static void input_type_convert_excitatory_input_to_current ( input_t *restrict  exc_input, const input_type_t *  input_type, state_t  membrane_voltage  )

static

Converts an excitatory input into an excitatory current.

Parameters

[in,out]	exc_input	Pointer to array of excitatory inputs from different receptors this timestep. Note that this will already have been scaled by input_type_get_input_value()
[in]	input_type	The input type pointer to the parameters
[in]	membrane_voltage	The membrane voltage to use for the input

input_type_convert_inhibitory_input_to_current()

static void input_type_convert_inhibitory_input_to_current ( input_t *restrict  inh_input, const input_type_t *  input_type, state_t  membrane_voltage  )

static

Converts an inhibitory input into an inhibitory current.

Parameters

[in,out]	inh_input	Pointer to array of inhibitory inputs from different receptors this timestep. Note that this will already have been scaled by input_type_get_input_value()
[in]	input_type	The input type pointer to the parameters
[in]	membrane_voltage	The membrane voltage to use for the input