neuron_impl_stoc_exp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 The University of Manchester
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
 
#ifndef _NEURON_IMPL_STOC_EXP_
#define _NEURON_IMPL_STOC_EXP_
 
#include <neuron/implementations/neuron_impl.h>
#include <spin1_api.h>
#include <debug.h>
#include <random.h>
#include <stdfix-full-iso.h>
#include <common/maths-util.h>
 
#define V_RECORDING_INDEX 0
#define EX_INPUT_INDEX 1
#define IN_INPUT_INDEX 2
#define PROB_INDEX 3
#define N_RECORDED_VARS 4
 
#define SPIKE_RECORDING_BITFIELD 0
#define N_BITFIELD_VARS 1
 
#include <neuron/neuron_recording.h>
 
#include <neuron/current_sources/current_source_impl.h>
#include <neuron/current_sources/current_source.h>
 
#include "stoc_exp_common.h"
 
typedef struct neuron_params_t {
 
    UREAL tau_ms;
 
    UREAL time_step;
 
    REAL bias;
 
    uint32_t refract_init;
 
    mars_kiss64_seed_t random_seed;
} neuron_params_t;
 
 
typedef struct neuron_impl_t {
 
    UFRACT tau_recip;
 
    REAL bias;
 
    uint32_t t_refract;
 
    uint32_t refract_timer;
 
    mars_kiss64_seed_t random_seed;
 
    input_t inputs[2];
} neuron_impl_t;
 
static neuron_impl_t *neuron_array;
 
static bool neuron_impl_initialise(uint32_t n_neurons) {
    // Allocate DTCM for neuron array
    neuron_array = spin1_malloc(n_neurons * sizeof(neuron_impl_t));
    if (neuron_array == NULL) {
        log_error("Unable to allocate neuron array - Out of DTCM");
        return false;
    }
 
    return true;
}
 
static inline void neuron_model_initialise(
        neuron_impl_t *state, neuron_params_t *params) {
    UREAL ts = params->time_step;
    state->tau_recip = ulrbits((
            bitsuk(ukdivuk(UREAL_CONST(1.0), params->tau_ms)) & 0xFFFF) << 16);
    state->bias = params->bias;
    state->t_refract = stoc_exp_ceil_accum(ukdivuk(params->tau_ms, ts));
    state->refract_timer = params->refract_init;
    spin1_memcpy(state->random_seed, params->random_seed, sizeof(mars_kiss64_seed_t));
    validate_mars_kiss64_seed(state->random_seed);
 
    // Reset the inputs
    state->inputs[0] = ZERO;
    state->inputs[1] = ZERO;
}
 
static inline void neuron_model_save_state(neuron_impl_t *state, neuron_params_t *params) {
    params->refract_init = state->refract_timer;
    spin1_memcpy(params->random_seed, state->random_seed, sizeof(mars_kiss64_seed_t));
}
 
static void neuron_impl_load_neuron_parameters(
        address_t address, uint32_t next, uint32_t n_neurons,
        address_t save_initial_state) {
 
    neuron_params_t *params = (neuron_params_t *) &address[next];
    for (uint32_t i = 0; i < n_neurons; i++) {
        neuron_model_initialise(&neuron_array[i], &params[i]);
    }
 
    // If we are to save the initial state, copy the whole of the parameters
    // to the initial state
    if (save_initial_state) {
        spin1_memcpy(save_initial_state, address,
                n_neurons * sizeof(neuron_params_t));
    }
}
 
static void neuron_impl_store_neuron_parameters(
        address_t address, uint32_t next, uint32_t n_neurons) {
    neuron_params_t *params = (neuron_params_t *) &address[next];
    for (uint32_t i = 0; i < n_neurons; i++) {
        neuron_model_save_state(&neuron_array[i], &params[i]);
    }
}
 
static void neuron_impl_add_inputs(
        index_t synapse_type_index, index_t neuron_index,
        input_t weights_this_timestep) {
    // Get the neuron itself
    neuron_impl_t *neuron = &neuron_array[neuron_index];
 
    // Do something to store the inputs for the next state update
    neuron->inputs[synapse_type_index] += weights_this_timestep;
}
 
// Update done when in refractory
static inline void do_refrac_update(uint32_t timer_count, uint32_t time,
        uint32_t neuron_index, neuron_impl_t *neuron) {
    neuron->refract_timer -= 1;
 
    // Record things
    neuron_recording_record_int32(PROB_INDEX, neuron_index, 0);
    neuron_recording_record_accum(V_RECORDING_INDEX, neuron_index, ZERO);
    neuron_recording_record_accum(EX_INPUT_INDEX, neuron_index, neuron->inputs[0]);
    neuron_recording_record_accum(IN_INPUT_INDEX, neuron_index, neuron->inputs[1]);
 
    // Reset the inputs
    neuron->inputs[0] = ZERO;
    neuron->inputs[1] = ZERO;
 
    // Send a spike
    neuron_recording_record_bit(SPIKE_RECORDING_BITFIELD, neuron_index);
    send_spike(timer_count, time, neuron_index);
}
 
static inline void do_non_refrac_update(uint32_t timer_count, uint32_t time,
        uint32_t neuron_index, neuron_impl_t *neuron) {
    // Work out the membrane voltage
    REAL v_membrane = (neuron->bias + neuron->inputs[0]) - neuron->inputs[1];
 
    // Record things
    neuron_recording_record_accum(V_RECORDING_INDEX, neuron_index, v_membrane);
    neuron_recording_record_accum(EX_INPUT_INDEX, neuron_index, neuron->inputs[0]);
    neuron_recording_record_accum(IN_INPUT_INDEX, neuron_index, neuron->inputs[1]);
 
    // Reset the inputs
    neuron->inputs[0] = ZERO;
    neuron->inputs[1] = ZERO;
 
    // Work out the probability
    uint32_t prob = get_probability(neuron->tau_recip, v_membrane);
 
    // Record the probability
    neuron_recording_record_int32(PROB_INDEX, neuron_index, (int32_t) prob);
 
    // Get a random number
    uint32_t random = mars_kiss64_seed(neuron->random_seed);
 
    // If the random number is less than the probability value, spike
    if (random < prob) {
        neuron->refract_timer = neuron->t_refract - 1;
        neuron_recording_record_bit(SPIKE_RECORDING_BITFIELD, neuron_index);
        send_spike(timer_count, time, neuron_index);
    }
}
 
static void neuron_impl_do_timestep_update(
        uint32_t timer_count, uint32_t time, uint32_t n_neurons) {
    for (uint32_t neuron_index = 0; neuron_index < n_neurons; neuron_index++) {
        // Get the neuron itself
        neuron_impl_t *neuron = &neuron_array[neuron_index];
 
        // If in refractory, count down and spike!
        if (neuron->refract_timer > 0) {
            do_refrac_update(timer_count, time, neuron_index, neuron);
        } else {
            do_non_refrac_update(timer_count, time, neuron_index, neuron);
        }
    }
}
 
#if LOG_LEVEL >= LOG_DEBUG
static void neuron_impl_print_inputs(uint32_t n_neurons) {
    log_debug("-------------------------------------\n");
    for (index_t i = 0; i < n_neurons; i++) {
        neuron_impl_t *neuron = &neuron_array[i];
        log_debug("inputs: %k %k", neuron->inputs[0], neuron->inputs[1]);
    }
    log_debug("-------------------------------------\n");
}
 
static void neuron_impl_print_synapse_parameters(uint32_t n_neurons) {
    // there aren't any accessible
    use(n_neurons);
}
 
static const char *neuron_impl_get_synapse_type_char(uint32_t synapse_type) {
    if (synapse_type == 0) {
        return 'E';
    } else if (synapse_type == 1) {
        return 'I';
    }
    return 'U';
}
#endif // LOG_LEVEL >= LOG_DEBUG
 
 
#endif // _NEURON_IMPL_STOC_EXP_