expose-workspace.cpp

Go to the documentation of this file.

#include "proxsuite-nlp/python/fwd.hpp"
 
#include "proxsuite-nlp/workspace.hpp"
 
namespace proxsuite {
namespace nlp {
namespace python {
void exposeWorkspace() {
  using context::Scalar;
  using context::Workspace;
  bp::class_<Workspace, boost::noncopyable>(
      "Workspace", "ProxNLPSolverTpl workspace.",
      bp::init<const context::Problem &>(bp::args("self", "problem")))
      .def_readonly("kkt_matrix", &Workspace::kkt_matrix, "KKT matrix buffer.")
      .def_readonly("kkt_rhs", &Workspace::kkt_rhs,
                    "KKT system right-hand side buffer.")
      .def_readonly("kkt_err", &Workspace::kkt_err, "KKT system error.")
      .def_readonly("pd_step", &Workspace::pd_step, "The primal-dual step.")
      .add_property(
          "prim_step",
          bp::make_getter(&Workspace::prim_step,
                          bp::return_value_policy<bp::return_by_value>()))
      .add_property(
          "dual_step",
          bp::make_getter(&Workspace::dual_step,
                          bp::return_value_policy<bp::return_by_value>()))
      .def_readonly("objective_value", &Workspace::objective_value)
      .def_readonly("objective_gradient", &Workspace::objective_gradient)
      .def_readonly("objective_hessian", &Workspace::objective_hessian)
      .def_readonly("merit_gradient", &Workspace::merit_gradient)
      .def_readonly("merit_dual_gradient", &Workspace::merit_dual_gradient)
      .def_readonly("data_cstr_values", &Workspace::data_cstr_values)
      .def_readonly("cstr_values", &Workspace::cstr_values,
                    "Vector constraint residuals.")
      .def_readonly("data_shift_cstr_values",
                    &Workspace::data_shift_cstr_values,
                    "Shifted constraint values.")
      .def_readonly("dual_residuals", &Workspace::dual_residual,
                    "Dual vector residual.")
      .def_readonly("data_jacobians", &Workspace::data_jacobians,
                    "Constraint Jacobians.")
      .def_readonly("data_hessians", &Workspace::data_hessians,
                    "Constraint vector-Hessian product matrices.")
      .def_readonly("cstr_jacobians", &Workspace::cstr_jacobians,
                    "Block jacobians.")
      .def_readonly("data_jacobians_proj", &Workspace::data_jacobians_proj,
                    "Projected constraint Jacobians.")
      .def_readonly("cstr_jacobians_proj", &Workspace::cstr_jacobians_proj,
                    "Projected constraint Jacobians.")
      .def_readonly("lams_plus", &Workspace::lams_plus,
                    "First-order multiplier estimates.")
      .def_readonly("data_lams_plus", &Workspace::data_lams_plus,
                    "First-order multiplier estimates.")
      .def_readonly("lams_plus_reproj", &Workspace::lams_plus_reproj,
                    "Product of projection Jacobian and first-order multiplier "
                    "estimates.")
      .def_readonly("data_lams_pdal", &Workspace::data_lams_pdal,
                    "Primal-dual multiplier estimates.")
      .def_readonly("lams_pdal", &Workspace::lams_pdal,
                    "Primal-dual multiplier estimates.")
      .def_readonly("alpha_opt", &Workspace::alpha_opt,
                    "Computed linesearch step length.")
      .def_readonly("dmerit_dir", &Workspace::dmerit_dir)
      // TODO: expose Workspace::ldlt_ once boost::variant can be exposed in
      // eigenpy
      ;
}
 
} // namespace python
} // namespace nlp
} // namespace proxsuite