Baillehache Pascal's personal website

LibCapy - noise

Noise generator parent class.

Macros:

#define CAPY_NOISE_H

#define CapyNoiseDef struct {        \
  struct CapyMathFunDef;             \
  CapyRandom rng;                    \
  void (*destructCapyMathFun)(void); \
  void (*init)(void);                \
}

CapyNoise object definition macro

Enumerations:

None.

Typedefs:

typedef CapyNoiseDef CapyNoise;

CapyNoise object

Functions:

CapyNoise CapyNoiseCreate(
  CapyRandomSeed_t const seed,
            size_t const dimIn,
            size_t const dimOut);

Create a CapyNoise

Input argument(s):

seed: seed of the noise
dimIn: number of inputs
dimOut: number of outputs

Output and side effect(s):

Return a CapyNoise

CapyNoise* CapyNoiseAlloc(
  CapyRandomSeed_t const seed,
            size_t const dimIn,
            size_t const dimOut);

Allocate memory for a new CapyNoise and create it

Input argument(s):

seed: seed of the noise
dimIn: number of inputs
dimOut: number of outputs

Output and side effect(s):

Return a CapyNoise

Exception(s):

May raise CapyExc_MallocFailed.

void CapyNoiseFree(CapyNoise** const that);

Free the memory used by a CapyNoise* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyNoise to free

2023-03-26
in LibCapy,
32 views