expose-cholesky.cpp

Go to the documentation of this file.

//
// Copyright (c) 2019-2020 CNRS INRIA
//
 
#include "pinocchio/bindings/python/algorithm/algorithms.hpp"
#include "pinocchio/bindings/python/utils/namespace.hpp"
#include "pinocchio/algorithm/cholesky.hpp"
 
#include "pinocchio/bindings/python/utils/model-checker.hpp"
 
namespace pinocchio
{
  namespace python
  {
 
    void exposeCholesky()
    {
      using namespace Eigen;
      using namespace pinocchio::cholesky;
 
      {
        typedef context::Scalar Scalar;
        typedef context::VectorXs VectorXs;
        enum
        {
          Options = context::Options
        };
 
        // using the cholesky scope
        bp::scope current_scope = getOrCreatePythonNamespace("cholesky");
 
        bp::def(
          "decompose", &decompose<Scalar, Options, JointCollectionDefaultTpl>,
          bp::args("Model", "Data"),
          "Computes the Cholesky decomposition of the joint space inertia matrix M contained "
          "in data.\n"
          "The upper triangular part of data.M should have been filled first by calling "
          "crba, or any related algorithms.",
          mimic_not_supported_function<bp::return_value_policy<bp::return_by_value>>(0));
 
        bp::def(
          "solve", &solve<Scalar, Options, JointCollectionDefaultTpl, VectorXs>,
          bp::args("Model", "Data", "v"),
          "Returns the solution \f$x\f$ of \f$ M x = y \f$ using the Cholesky decomposition "
          "stored in data given the entry \f$ y \f$.",
          mimic_not_supported_function<bp::return_value_policy<bp::return_by_value>>(0));
 
        bp::def(
          "computeMinv", &computeMinv<Scalar, Options, JointCollectionDefaultTpl>,
          bp::args("Model", "Data"),
          "Returns the inverse of the joint space inertia matrix using the results of the "
          "Cholesky decomposition\n"
          "performed by cholesky.decompose. The result is stored in data.Minv.",
          mimic_not_supported_function<bp::return_value_policy<bp::return_by_value>>(0));
      }
    }
 
  } // namespace python
} // namespace pinocchio