sPyNNaker neural_modelling  7.4.2
synapse_structure_weight_state_accumulator_impl.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 The University of Manchester
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
19 #ifndef _SYNAPSE_STRUCUTRE_WEIGHT_STATE_ACCUMULATOR_IMPL_H_
20 #define _SYNAPSE_STRUCUTRE_WEIGHT_STATE_ACCUMULATOR_IMPL_H_
21 
22 //---------------------------------------
23 // Structures
24 //---------------------------------------
27 typedef struct plastic_synapse_t {
28  weight_t weight;
29  int8_t accumulator;
30  uint8_t state;
32 
35 typedef struct update_state_t {
37  int32_t accumulator;
38  int32_t state;
40 
43 
44 #include "synapse_structure.h"
45 
55  plastic_synapse_t synaptic_word, index_t synapse_type) {
56  update_state_t update_state = {
57  .weight_state = weight_get_initial(synaptic_word.weight, synapse_type),
58  .accumulator = (int32_t) synaptic_word.accumulator,
59  .state = (uint32_t) synaptic_word.state
60  };
61  return update_state;
62 }
63 
64 //---------------------------------------
69  update_state_t state) {
70  // Get weight from state
71  weight_t weight = weight_get_final(state.weight_state);
72 
73  // Build this into synaptic word along with updated accumulator and state
74  return (final_state_t) {
75  .weight = weight,
76  .accumulator = (int8_t) state.accumulator,
77  .state = (uint8_t) state.state
78  };
79 }
80 
81 //---------------------------------------
85 static inline weight_t synapse_structure_get_final_weight(
86  final_state_t final_state) {
87  return final_state.weight;
88 }
89 
90 //---------------------------------------
95  final_state_t final_state) {
96  return final_state;
97 }
98 
99 //---------------------------------------
104  weight_t weight) {
105  plastic_synapse_t initial = {
106  .weight = weight,
107  .accumulator = 0,
108  .state = 0
109  };
110  return initial;
111 }
112 
113 //---------------------------------------
117 static inline weight_t synapse_structure_get_weight(
118  plastic_synapse_t synaptic_word) {
119  return synaptic_word.weight;
120 }
121 
122 static inline void synapse_structure_decay_weight(
123  update_state_t *state, uint32_t decay) {
124  return weight_decay(&(state->weight_state), decay);
125 }
126 
127 static inline accum synapse_structure_get_update_weight(update_state_t state) {
128  return weight_get_update(state.weight_state);
129 }
130 
131 #endif _SYNAPSE_STRUCUTRE_WEIGHT_STATE_ACCUMULATOR_IMPL_H_
#define decay(x, d)
This is a type-generic decay "function".
Definition: decay.h:118
API for synaptic state.
static accum synapse_structure_get_update_weight(update_state_t state)
Get the current synaptic weight stored in the update state.
static void synapse_structure_decay_weight(update_state_t *state, uint32_t decay)
Decay the synaptic weight value stored by multiplication.
weight_t plastic_synapse_t
Plastic synapse types are just weights;.
weight_state_t update_state_t
The update state is purely a weight state.
plastic_synapse_t final_state_t
Final states are actually directly what is stored.
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 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 weight_t synapse_structure_get_final_weight(final_state_t final_state)
Get the final weight from the final state.
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_weight(plastic_synapse_t synaptic_word)
Get the current synaptic weight from the plastic synapse data.
weight_state_t weight_state
The weight staet.
int32_t accumulator
The accumulator (in ARM-friendly format)
Plastic synapse contains normal 16-bit weight and an accumulator.
static weight_t weight_get_final(weight_state_t new_state)
Gets the final weight.
static weight_state_t weight_get_initial(weight_t weight, index_t synapse_type)
Gets the initial weight state.
static void weight_decay(weight_state_t *state, int32_t decay)
Decay the weight inside the state by multiplication.
static accum weight_get_update(weight_state_t state)
Get the weight inside during update in STDP fixed point format.
The current state data for the rule.