Baillehache Pascal's personal website

LibCapy - idxCombination

Iterator on combination of indices.

Macros:

#define CAPY_COMBINATOR_H

Enumerations:

None.

Typedefs:

None.

Struct CapyIdxCombination :

Struct CapyIdxCombination's properties:

  size_t dim;

Dimension of the combination

  size_t* indices;

Current indices

  CapyRangeSize* ranges;

Ranges for each indices (default: [0,1], inclusive)

  size_t* datatype;

Fields for the forEach macro

  size_t idx;

Index in iteration

Struct CapyIdxCombination's methods:

  size_t** (*reset)(void);

Methods for the forEach macro

  bool (*isActive)(void);

  size_t** (*next)(void);

  void (*destruct)(void);

Destructor

Functions:

CapyIdxCombination CapyIdxCombinationCreate(size_t const dim);

Create a CapyIdxCombination

Input argument(s):

dim: dimension of the combination

Output and side effect(s):

Return a CapyIdxCombination

CapyIdxCombination* CapyIdxCombinationAlloc(size_t const dim);

Allocate memory for a new CapyIdxCombination and create it

Input argument(s):

dim: dimension of the combination

Output and side effect(s):

Return a CapyIdxCombination

Exception(s):

May raise CapyExc_MallocFailed.

void CapyIdxCombinationFree(CapyIdxCombination** const that);

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

Input argument(s):

that: a pointer to the CapyIdxCombination to free

2023-08-04
in LibCapy,
5 views