siconos.numerics.NCP (Python class)

class siconos.numerics.NCP(*args)[source]

Bases: object

The structure that defines a Nonlinear Complementarity Problem (NCP) : Find two vectors \((z,w \in {{\mathrm{I\!R}}}^{n})\) such that:

w &= F(z) \ 0 &le w perp z ge 0

Generated class (swig), based on C++ header Program listing for file numerics/src/NCP/NonlinearComplementarityProblem.h.

Attributes:
  • compute_F (ptrFunctionNCP) – pointer to the function used to compute \(F(z)\)

  • compute_nabla_F (ptrFunctionJacNCP) – pointer to the function used to compute \(\nabla_z F(z)\)

  • env (None *) – environment for the compute_Fmcp and compute_nabla_F function.

    When called from Python, it contains an object with compute_F and compute_nabla_F as methods. When called from C, it can reference a data struct containing variables needed for the computations.

  • n (``) – size of the problem

  • nabla_F (NumericsMatrix *) – storage for \(\nabla_z F\)