synapse_structure.h File Reference

API for synaptic state. More...

#include <neuron/plasticity/stdp/weight_dependence/weight.h>

Go to the source code of this file.

Functions
static update_state_t	synapse_structure_get_update_state (plastic_synapse_t synaptic_word, index_t synapse_type)
	Get the update state from the synapse structure.
static final_state_t	synapse_structure_get_final_state (update_state_t state)
	Get the final state from the update state.
static weight_t	synapse_structure_get_final_weight (final_state_t final_state)
	Get the final weight from the final state.
static plastic_synapse_t	synapse_structure_get_final_synaptic_word (final_state_t final_state)
	Get the final plastic synapse data from the final state.
static plastic_synapse_t	synapse_structure_create_synapse (weight_t weight)
	Create the initial plastic synapse data.
static weight_t	synapse_structure_get_weight (plastic_synapse_t synaptic_word)
	Get the current synaptic weight from the plastic synapse data.
static void	synapse_structure_decay_weight (update_state_t *state, uint32_t decay)
	Decay the synaptic weight value stored by multiplication.
static accum	synapse_structure_get_update_weight (update_state_t state)
	Get the current synaptic weight stored in the update state.

Detailed Description

API for synaptic state.

Implementations of this have one or more of:

• weight
• state
• accumulator
• event window

Definition in file synapse_structure.h.

Function Documentation

synapse_structure_get_update_state()

static update_state_t synapse_structure_get_update_state ( plastic_synapse_t  synaptic_word, index_t  synapse_type  )

static

Get the update state from the synapse structure.

Parameters

[in]	synaptic_word	The plastic synapse data
[in]	synapse_type	What (supported) type of synapse is this?

Returns

The update state

synapse_structure_get_final_state()

static final_state_t synapse_structure_get_final_state ( update_state_t  state )

static

Get the final state from the update state.

Parameters

[in]

state

the update state

Returns

the final state

synapse_structure_get_final_weight()

static weight_t synapse_structure_get_final_weight ( final_state_t  final_state )

static

Get the final weight from the final state.

Parameters

[in]

final_state

the final state

Returns

the final weight

synapse_structure_get_final_synaptic_word()

static plastic_synapse_t synapse_structure_get_final_synaptic_word ( final_state_t  final_state )

static

Get the final plastic synapse data from the final state.

Parameters

[in]

final_state

the final state

Returns

the final plastic synapse data, ready to be stored

synapse_structure_create_synapse()

static plastic_synapse_t synapse_structure_create_synapse ( weight_t  weight )

static

Create the initial plastic synapse data.

Parameters

[in]

weight

the initial synaptic weight

Returns

the plastic synapse data

synapse_structure_get_weight()

static weight_t synapse_structure_get_weight ( plastic_synapse_t  synaptic_word )

static

Get the current synaptic weight from the plastic synapse data.

Parameters

[in]

synaptic_word

the plastic synapse data

Returns

the current synaptic weight

synapse_structure_decay_weight()

static void synapse_structure_decay_weight ( update_state_t *  state, uint32_t  decay  )

static

Decay the synaptic weight value stored by multiplication.

Parameters

[in]	state	The update state containing the current weight
[in]	decay	The "decay" to multiply the weight by, in STDP fixed point format

synapse_structure_get_update_weight()

static accum synapse_structure_get_update_weight ( update_state_t  state )

static

Get the current synaptic weight stored in the update state.

Parameters

[in]

state

The update state containing the current weight

Returns

The current weight in s1615 fixed point format