param_generator_normal_clipped.h File Reference

Normally distributed random, redrawn if out of boundary, parameter generator implementation. More...

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

Go to the source code of this file.

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

Macros
#define	MAX_REDRAWS   1000
	The maximum number of redraws performed before giving up.

Functions
static void *	param_generator_normal_clipped_initialize (void **region)
	How to initialise the clipped normal RNG parameter generator.
static void	param_generator_normal_clipped_free (void *generator)
	How to free any data for the clipped normal RNG parameter generator.
static accum	param_generator_normal_clipped_generate (void *generator)
	How to generate values with the clipped normal RNG parameter generator.

Detailed Description

Normally distributed random, redrawn if out of boundary, parameter generator implementation.

Definition in file param_generator_normal_clipped.h.

---

Data Structure Documentation

normal_clipped_params

struct normal_clipped_params

The parameters that can be copied in from SDRAM.

Definition at line 37 of file param_generator_normal_clipped.h.

Data Fields
accum	mu
accum	sigma
accum	low
accum	high

param_generator_normal_clipped

struct param_generator_normal_clipped

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

Definition at line 48 of file param_generator_normal_clipped.h.

Data Fields
struct normal_clipped_params	params

Macro Definition Documentation

MAX_REDRAWS

#define MAX_REDRAWS   1000

The maximum number of redraws performed before giving up.

Definition at line 32 of file param_generator_normal_clipped.h.

Function Documentation

param_generator_normal_clipped_initialize()

static void * param_generator_normal_clipped_initialize ( void **  region )

static

How to initialise the clipped normal 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 58 of file param_generator_normal_clipped.h.

param_generator_normal_clipped_free()

static void param_generator_normal_clipped_free ( void *  generator )

static

How to free any data for the clipped normal RNG parameter generator.

Parameters

[in]

generator

The generator to free

Definition at line 78 of file param_generator_normal_clipped.h.

param_generator_normal_clipped_generate()

static accum param_generator_normal_clipped_generate ( void *  generator )

static

How to generate values with the clipped normal RNG parameter generator.

Parameters

[in]

generator

The generator to use to generate values

Returns

The generated value

Definition at line 87 of file param_generator_normal_clipped.h.