Baillehache Pascal's personal website

LibCapy - mathfun

Class to manipulate mathematical functions.

Macros:

#define CAPY_MATHFUN_H

#define CapyMathFunDef {              \
  union {                             \
    size_t dims[2];                   \
    struct __attribute__((packed)) {  \
      size_t dimIn, dimOut;           \
    };                                \
  };                                  \
  size_t nbIterSolveNewtonMethod;     \
  CapyRangeDouble* domains;           \
  void (*destruct)(void);             \
  void (*eval)(                       \
    double const* const in,           \
          double* const out);         \
  void (*evalJacobian)(               \
    double const* const in,           \
          double* const jacobian);    \
  void (*evalDerivative)(             \
       double const* const in,        \
              size_t const iDim,      \
             double* const out);      \
  double (*evalDivergence)(           \
    double const* const in);          \
  void (*solveByNewtonMethod)(        \
          double* const in,           \
    double const* const out);         \
}

CapyMathFun object definition macro

Enumerations:

None.

Typedefs:

typedef struct CapyMathFun CapyMathFunDef CapyMathFun;

CapyMathFun object

Struct CapyHyperplane :

Struct CapyHyperplane's properties:

  struct CapyMathFunDef;

Inherit CapyMathFun

  CapyVec u;

Hyperplane parameters, the hyperplane is defined as the points X such as H(X)=u.[X|1]=0

Struct CapyHyperplane's methods:

  void (*destructCapyMathFun)(void);

Destructor

Functions:

CapyMathFun CapyMathFunCreate(
  size_t const dimIn,
  size_t const dimOut);

Create a CapyMathFun

Input argument(s):

dimIn: input dimension
dimOut: output dimension

Output and side effect(s):

Return a CapyMathFun. domains set by default to [0, 1]

CapyHyperplane CapyHyperplaneCreate(size_t const dimIn);

Create a CapyHyperplane

Input argument(s):

dimIn: input dimension

Output and side effect(s):

Return a CapyHyperplane.

CapyHyperplane* CapyHyperplaneAlloc(size_t const dimIn);

Allocate memory and create a CapyHyperplane

Input argument(s):

dimIn: input dimension

Output and side effect(s):

Return a CapyHyperplane.

void CapyHyperplaneFree(CapyHyperplane** const that);

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

Input argument(s):

that: the CapyHyperplane to free

2022-02-15
in LibCapy,
41 views