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;                \
  double* outBuffer;                       \
  void (*destruct)(void);                  \
  void (*eval)(                            \
    double const* const in,                \
          double* const out);              \
  void (*evalJacobian)(                    \
    double* const in,                      \
    double* const jacobian);               \
  void (*evalDerivative)(                  \
       double* const in,                   \
        size_t const iDim,                 \
       double* const out);                 \
  void (*evalIntegral)(                    \
    CapyRangeDouble const* const domains,  \
                   double* const out);     \
  double (*evalDivergence)(                \
    double* 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

typedef struct CapyDataset CapyDataset;

Predeclaration

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

Struct CapyLinCombFun :

Struct CapyLinCombFun's properties:

  struct CapyMathFunDef;

Inherit CapyMathFun

  size_t nbComb;

Number of linearly combined functions

  CapyVec coeff;

Vector of coefficients for the combination

  CapyVec bias;

Bias coefficient

  CapyVec out;

Temporary vector for calculation

  CapyMathFun** combFuns;

References to the combined functions

Struct CapyLinCombFun's methods:

  void (*destructCapyMathFun)(void);

Destructor

  void (*linearRegression)(
    CapyDataset const* const dataset,
                size_t const iOutput);

Calculate the combination coefficients that best fit a dataset

Input argument(s):

dataset: the dataset
iOutput: the index of the output

Output and side effect(s):

Calculate the best fit coefficients using linear regression. The number of input fields in the dataset must match the input dimension of combined functions. Can be used for dimOut=1 only.

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

CapyLinCombFun CapyLinCombFunCreate(
  size_t const nbComb,
  size_t const dimIn,
  size_t const dimOut);

Create a CapyLinCombFun

Input argument(s):

nbComb: number of linearly combined functions
dimIn: input dimension
dimOut: output dimension

Output and side effect(s):

Return a CapyLinCombFun.

CapyLinCombFun* CapyLinCombFunAlloc(
  size_t const nbComb,
  size_t const dimIn,
  size_t const dimOut);

Allocate memory and create a CapyLinCombFun

Input argument(s):

nbComb: number of linearly combined functions
dimIn: input dimension
dimOut: output dimension

Output and side effect(s):

Return a CapyLinCombFun.

void CapyLinCombFunFree(CapyLinCombFun** const that);

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

Input argument(s):

that: the CapyLinCombFun to free

2022-02-15
in LibCapy,
78 views