Baillehache Pascal's personal website

LibCapy - sampling

Sampling function parent class.

Macros:

#define CAPY_SAMPLING_H

#define CapySamplingDef struct {    \
  CapyRandom rng;                   \
  size_t dim;                       \
  CapyRangeDouble* domains;         \
  void (*destruct)(void);           \
  CapySamples* (*getSamples)(void); \
}

CapySampling object definition macro

Enumerations:

None.

Typedefs:

typedef CapySamplingDef CapySampling;

CapySampling object

Struct CapySample :

Struct CapySample's properties:

  double* vals;

Values of the sample

Struct CapySample's methods:

  void (*destruct)(void);

Destructor

Functions:

CapySample CapySampleCreate(size_t const dim);

Create a CapySample

Input argument(s):

dim: dimension of the sample

Output and side effect(s):

Return a CapySample

CapySampling CapySamplingCreate(
  CapyRandomSeed_t const seed,
            size_t const dim);

Create a CapySampling

Input argument(s):

seed: seed for the random number generator
dim: dimension of the samples

Output and side effect(s):

Return a CapySampling

CapySampling* CapySamplingAlloc(
  CapyRandomSeed_t const seed,
            size_t const dim);

Allocate memory for a new CapySampling and create it

Input argument(s):

seed: seed for the random number generator
dim: dimension of the samples

Output and side effect(s):

Return a CapySampling

Exception(s):

May raise CapyExc_MallocFailed.

void CapySamplingFree(CapySampling** const that);

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

Input argument(s):

that: a pointer to the CapySampling to free

2023-08-04
in LibCapy,
3 views