Baillehache Pascal's personal website

LibCapy - slidingAverage

Sliding average class.

Macros:

#define CAPY_SLIDING_AVERAGE_H

Enumerations:

None.

Typedefs:

None.

Struct CapySlidingAverage :

Struct CapySlidingAverage's properties:

  size_t size;

Size of the sliding window

  size_t counter;

Counter to memorise when the window is filled

  double val;

Current average value

Struct CapySlidingAverage's methods:

  void (*destruct)(void);

Destructor

  void (*update)(double const val);

Update the average with a new value

Input argument(s):

val: the new value

Output and side effect(s):

Update the current average and counter

Functions:

CapySlidingAverage CapySlidingAverageCreate(size_t const size);

Create a CapySlidingAverage

Input argument(s):

size: the size of the sliding window

Output and side effect(s):

Return a CapySlidingAverage

CapySlidingAverage* CapySlidingAverageAlloc(size_t const size);

Allocate memory for a new CapySlidingAverage and create it

Input argument(s):

size: the size of the sliding window

Output and side effect(s):

Return a CapySlidingAverage

Exception(s):

May raise CapyExc_MallocFailed.

void CapySlidingAverageFree(CapySlidingAverage** const that);

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

Input argument(s):

that: a pointer to the CapySlidingAverage to free

2023-03-26
in LibCapy,
40 views