param_generator_uniform.h File Reference

Uniformly distributed random set to boundary parameter generator implementation. More...

#include <stdfix.h>
#include <spin1_api.h>
#include <stdfix-full-iso.h>
#include <synapse_expander/rng.h>
#include <synapse_expander/generator_types.h>

Go to the source code of this file.

Data Structures
struct	uniform_params
	The parameters that can be copied in from SDRAM. More...
struct	param_generator_uniform
	The data structure to be passed around for this generator. This includes the parameters and an RNG. More...

Functions
static void *	param_generator_uniform_initialize (void **region)
	How to initialise the uniform RNG parameter generator.
static void	param_generator_uniform_free (void *generator)
	How to free any data for the uniform RNG parameter generator.
static accum	param_generator_uniform_generate (void *generator)
	How to generate values with the uniform RNG parameter generator.

Detailed Description

Uniformly distributed random set to boundary parameter generator implementation.

Definition in file param_generator_uniform.h.

---

Data Structure Documentation

uniform_params

struct uniform_params

The parameters that can be copied in from SDRAM.

Definition at line 31 of file param_generator_uniform.h.

Data Fields
accum	low
accum	high

param_generator_uniform

struct param_generator_uniform

The data structure to be passed around for this generator. This includes the parameters and an RNG.

Definition at line 40 of file param_generator_uniform.h.

Data Fields
struct uniform_params	params

Function Documentation

param_generator_uniform_initialize()

static void * param_generator_uniform_initialize ( void **  region )

static

How to initialise the uniform RNG parameter generator.

Parameters

[in,out]

region

Region to read setup from. Should be updated to position just after parameters after calling.

Returns

A data item to be passed in to other functions later on

Definition at line 50 of file param_generator_uniform.h.

param_generator_uniform_free()

static void param_generator_uniform_free ( void *  generator )

static

How to free any data for the uniform RNG parameter generator.

Parameters

[in]

generator

The generator to free

Definition at line 70 of file param_generator_uniform.h.

param_generator_uniform_generate()

static accum param_generator_uniform_generate ( void *  generator )

static

How to generate values with the uniform RNG parameter generator.

Parameters

[in]

generator

The generator to use to generate values

Returns

The generated value

Definition at line 79 of file param_generator_uniform.h.