sPyNNaker neural_modelling 7.3.1
Loading...
Searching...
No Matches
Functions
param_generator.h File Reference

Interface for parameter generator. More...

#include <common-typedefs.h>

Go to the source code of this file.

Functions

param_generator_t param_generator_init (uint32_t hash, void **region)
 Initialise a specific parameter generator.
 
accum param_generator_generate (param_generator_t generator)
 Generate value with a parameter generator.
 
void param_generator_free (param_generator_t generator)
 Finish with a parameter generator.
 

Detailed Description

Interface for parameter generator.

Definition in file param_generator.h.

Function Documentation

◆ param_generator_init()

param_generator_t param_generator_init ( uint32_t  hash,
void **  region 
)

Initialise a specific parameter generator.

Parameters
[in]hashThe identifier of the generator to initialise
[in,out]regionThe address to read data from; updated to position after data has been read
Returns
An initialised parameter generator that can be used with other functions, or NULL if it couldn't be initialised for any reason

Definition at line 114 of file param_generator.c.

◆ param_generator_generate()

accum param_generator_generate ( param_generator_t  generator)

Generate value with a parameter generator.

Parameters
[in]generatorThe generator to use to generate values
Returns
The value generated

Definition at line 141 of file param_generator.c.

◆ param_generator_free()

void param_generator_free ( param_generator_t  generator)

Finish with a parameter generator.

Parameters
[in]generatorThe generator to free

Definition at line 145 of file param_generator.c.