param_generator.c

Go to the documentation of this file.

/*
 * Copyright (c) 2017 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.
 */
 
#include "param_generator.h"
#include <spin1_api.h>
#include <debug.h>
#include "generator_types.h"
 
#include "param_generators/param_generator_constant.h"
#include "param_generators/param_generator_uniform.h"
#include "param_generators/param_generator_normal.h"
#include "param_generators/param_generator_normal_clipped.h"
#include "param_generators/param_generator_normal_clipped_to_boundary.h"
#include "param_generators/param_generator_exponential.h"
#include "param_generators/param_generator_exponential_clipped.h"
 
enum {
    CONSTANT,
    UNIFORM,
    NORMAL,
    NORMAL_CLIPPED,
    NORMAL_CLIPPED_BOUNDARY,
    EXPONENTIAL,
    EXPONENTIAL_CLIPPED,
    N_PARAM_GENERATORS
};
 
typedef struct param_generator_info {
    generator_hash_t hash;
    initialize_param_func *initialize;
    generate_param_func *generate;
    free_func *free;
} param_generator_info;
 
struct param_generator {
    const param_generator_info *type;
    void *data;
};
 
static const struct param_generator_info param_generators[] = {
    {CONSTANT,
            param_generator_constant_initialize,
            param_generator_constant_generate,
            param_generator_constant_free},
    {UNIFORM,
            param_generator_uniform_initialize,
            param_generator_uniform_generate,
            param_generator_uniform_free},
    {NORMAL,
            param_generator_normal_initialize,
            param_generator_normal_generate,
            param_generator_normal_free},
    {NORMAL_CLIPPED,
            param_generator_normal_clipped_initialize,
            param_generator_normal_clipped_generate,
            param_generator_normal_clipped_free},
    {NORMAL_CLIPPED_BOUNDARY,
            param_generator_normal_clipped_boundary_initialize,
            param_generator_normal_clipped_boundary_generate,
            param_generator_normal_clipped_boundary_free},
    {EXPONENTIAL,
            param_generator_exponential_initialize,
            param_generator_exponential_generate,
            param_generator_exponential_free},
    {EXPONENTIAL_CLIPPED,
            param_generator_exponential_clipped_initialize,
            param_generator_exponential_clipped_generate,
            param_generator_exponential_clipped_free}
};
 
param_generator_t param_generator_init(uint32_t hash, void **in_region) {
    // Look through the known generators
    for (uint32_t i = 0; i < N_PARAM_GENERATORS; i++) {
        const param_generator_info *type = &param_generators[i];
 
        // If the hash requested matches the hash of the generator, use it
        if (hash == type->hash) {
            // Prepare a space for the data
            struct param_generator *generator =
                    spin1_malloc(sizeof(struct param_generator));
            if (generator == NULL) {
                log_error("Could not create generator");
                return NULL;
            }
 
            // Store the index
            generator->type = type;
 
            // Initialise the generator and store the data
            generator->data = type->initialize(in_region);
            return generator;
        }
    }
    log_error("Param generator with hash %u not found", hash);
    return NULL;
}
 
accum param_generator_generate(param_generator_t generator) {
    return generator->type->generate(generator->data);
}
 
void param_generator_free(param_generator_t generator) {
    generator->type->free(generator->data);
    sark_free(generator);
}