generator_types.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 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 INCLUDED_GENERATOR_TYPES_H
#define INCLUDED_GENERATOR_TYPES_H
 
#include <common-typedefs.h>
#include <spin1_api.h>
#include "param_generator.h"
#include "matrix_generator.h"
 
#ifndef UNUSED
#define UNUSED __attribute__((__unused__))
#endif
 
typedef uint32_t generator_hash_t;
 
typedef void* (initialize_param_func)(void **region);
 
typedef void* (initialize_connector_func)(void **region);
 
typedef void* (initialize_matrix_func)(void **region, void *synaptic_matrix);
 
typedef void (free_func)(void *data);
 
typedef accum (generate_param_func)(void *generator);
 
typedef bool (write_synapse_func)(void *generator,
        uint32_t pre_index, uint16_t post_index, accum weight, uint16_t delay,
        unsigned long accum weight_scale);
 
typedef bool (generate_connection_func)(
        void *generator, uint32_t pre_lo, uint32_t pre_hi,
        uint32_t post_lo, uint32_t post_hi, uint32_t post_index,
        uint32_t post_slice_start, uint32_t post_slice_count,
        unsigned long accum weight_scale, accum timestep_per_delay,
        param_generator_t weight_generator, param_generator_t delay_generator,
        matrix_generator_t matrix_generator);
 
static inline uint16_t rescale_delay(accum delay, accum timestep_per_delay) {
    accum ts_delay = delay * timestep_per_delay;
    if (ts_delay < 0) {
        ts_delay = 1;
    }
    uint16_t delay_int = (uint16_t) ts_delay;
    if (ts_delay != delay_int) {
        log_debug("Rounded delay %k to %u", delay, delay_int);
    }
    return delay_int;
}
 
static inline uint16_t rescale_weight(accum weight, unsigned long accum weight_scale) {
    unsigned long accum uweight = 0;
    if (weight < 0) {
        uweight = -weight;
    } else {
        uweight = weight;
    }
    unsigned long accum weight_scaled = uweight * weight_scale;
    unsigned long accum weight_rounded = roundulk(weight_scaled, 32);
    uint16_t weight_int = (uint16_t) (bitsulk(weight_rounded) >> 32);
    if (weight_scaled != weight_int) {
        log_debug("Rounded weight %k to %u (scale is %k)",
                weight_scaled, weight_int, weight_scale);
    }
    return weight_int;
}
 
#define max(a, b) (a > b? a: b)
 
#endif //INCLUDED_GENERATOR_TYPES_H