serialization of dense qp wrapper (cpp/py)

- save/load model, results, settings
- ignore ruiz eq. and workspace

Author: fabinsch

bindings/python/src/expose-qpobject.hpp

@@ -8,6 +8,10 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/eigen.h>
 #include <pybind11/stl.h>
+#ifdef PROXSUITE_WITH_SERIALIZATION
+#include <proxsuite/proxqp/serialization/archive.hpp>
+#include <proxsuite/proxqp/serialization/wrapper.hpp>
+#endif
 
 namespace proxsuite {
 namespace proxqp {
@@ -114,7 +118,22 @@ exposeQpObjectDense(pybind11::module_ m)
     .def("cleanup",
          &dense::QP<T>::cleanup,
          "function used for cleaning the workspace and result "
-         "classes.");
+         "classes.")
+    .def(pybind11::self == pybind11::self)
+    .def(pybind11::self != pybind11::self)
+#ifdef PROXSUITE_WITH_SERIALIZATION
+    .def(pybind11::pickle(
+
+      [](const dense::QP<T>& qp) {
+        return pybind11::bytes(proxsuite::serialization::saveToString(qp));
+      },
+      [](pybind11::bytes& s) {
+        proxsuite::proxqp::dense::QP<T> qp(1, 1, 1);
+        proxsuite::serialization::loadFromString(qp, s);
+        return qp;
+      }));
+#endif
+  ;
 }
 } // namespace python
 } // namespace dense

include/proxsuite/proxqp/dense/wrapper.hpp

@@ -459,6 +459,23 @@ solve(
 
   return Qp.results;
 }
+
+template<typename T>
+bool
+operator==(const QP<T>& qp1, const QP<T>& qp2)
+{
+  bool value = qp1.model == qp2.model && qp1.settings == qp2.settings &&
+               qp1.results == qp2.results;
+  return value;
+}
+
+template<typename T>
+bool
+operator!=(const QP<T>& qp1, const QP<T>& qp2)
+{
+  return !(qp1 == qp2);
+}
+
 } // namespace dense
 } // namespace proxqp
 } // namespace proxsuite

include/proxsuite/proxqp/serialization/wrapper.hpp

@@ -0,0 +1,24 @@
+//
+// Copyright (c) 2022 INRIA
+//
+/**
+ * @file wrapper.hpp
+ */
+
+#ifndef PROXSUITE_SERIALIZATION_WRAPPER_HPP
+#define PROXSUITE_SERIALIZATION_WRAPPER_HPP
+
+#include <cereal/cereal.hpp>
+#include <proxsuite/proxqp/dense/wrapper.hpp>
+
+namespace cereal {
+
+template<class Archive, typename T>
+void
+serialize(Archive& archive, proxsuite::proxqp::dense::QP<T>& qp)
+{
+  archive(
+    CEREAL_NVP(qp.model), CEREAL_NVP(qp.results), CEREAL_NVP(qp.settings));
+}
+} // namespace cereal
+#endif /* end of include guard PROXSUITE_SERIALIZATION_WRAPPER_HPP */

test/src/serialization.cpp

@@ -38,6 +38,8 @@ DOCTEST_TEST_CASE("test serialization of qp model, results and settings")
   generic_test(qp.model, TEST_SERIALIZATION_FOLDER "/qp_model");
   generic_test(qp.settings, TEST_SERIALIZATION_FOLDER "/qp_settings");
   generic_test(qp.results, TEST_SERIALIZATION_FOLDER "/qp_results");
+
+  generic_test(qp, TEST_SERIALIZATION_FOLDER "/qp_wrapper");
 }
 
 DOCTEST_TEST_CASE(

test/src/serialization.hpp

@@ -5,6 +5,7 @@
 #include <proxsuite/proxqp/serialization/model.hpp>
 #include <proxsuite/proxqp/serialization/results.hpp>
 #include <proxsuite/proxqp/serialization/settings.hpp>
+#include <proxsuite/proxqp/serialization/wrapper.hpp>
 
 template<typename object>
 struct init;
@@ -45,6 +46,18 @@ struct init<proxsuite::proxqp::Settings<T>>
   }
 };
 
+template<typename T>
+struct init<proxsuite::proxqp::dense::QP<T>>
+{
+  typedef proxsuite::proxqp::dense::QP<T> QP;
+
+  static QP run()
+  {
+    QP qp(1, 0, 0);
+    return qp;
+  }
+};
+
 template<typename T>
 void
 generic_test(const T& object, const std::string& filename)

test/src/serialization.py

@@ -90,6 +90,7 @@ def test_pickle(self):
         generic_test(qp.model, "qp_model")
         generic_test(qp.settings, "qp_settings")
         generic_test(qp.results, "qp_results")
+        generic_test(qp, "qp_wrapper")
 
 
 if __name__ == "__main__":