Merge pull request #152 from fabinsch/topic/serialize-qp-model-cereal

Add serialization of dense qp model using cereal

Author: jcarpent

.gitmodules

@@ -3,4 +3,7 @@
 	url = https://github.com/pybind/pybind11
 [submodule "cmake-module"]
 	path = cmake-module
-	url = https://github.com/jrl-umi3218/jrl-cmakemodules.git
+	url = https://github.com/jrl-umi3218/jrl-cmakemodules.git
+[submodule "external/cereal"]
+	path = external/cereal
+	url = https://github.com/USCiLab/cereal.git

CMakeLists.txt

@@ -141,6 +141,18 @@ if(BUILD_WITH_VECTORIZATION_SUPPORT)
   list(APPEND EXPORTED_TARGETS_LIST proxsuite-vectorized)
 endif()
 
+if(BUILD_TESTING OR BUILD_PYTHON_INTERFACE)
+  # Download cereal for pything bindings and unittests
+  set(cereal_dir ${PROJECT_SOURCE_DIR}/external/cereal)
+  set(cereal ${cereal_dir}/README.md)
+  find_package(Git REQUIRED)
+  if(NOT EXISTS ${cereal})
+    execute_process(
+      COMMAND ${GIT_EXECUTABLE} submodule update --init ${cereal_dir}
+      WORKING_DIRECTORY ${cereal_dir} COMMAND_ERROR_IS_FATAL ANY)
+  endif()
+endif()
+
 if(NOT PROXSUITE_AS_SUBPROJECT)
   install(
     TARGETS ${EXPORTED_TARGETS_LIST}

bindings/python/CMakeLists.txt

@@ -51,6 +51,8 @@ function(CREATE_PYTHON_TARGET target_name COMPILE_OPTIONS dependencies)
   target_link_libraries(${target_name} PRIVATE proxsuite pybind11::module)
   target_compile_definitions(${target_name}
                              PRIVATE PYTHON_MODULE_NAME=${target_name})
+  target_include_directories(
+    ${target_name} PRIVATE ${PROJECT_SOURCE_DIR}/external/cereal/include)
   set_target_properties(
     ${target_name}
     PROPERTIES OUTPUT_NAME ${target_name}

bindings/python/src/expose-model.hpp

@@ -1,11 +1,17 @@
 //
 // Copyright (c) 2022 INRIA
 //
-#include <proxsuite/proxqp/dense/model.hpp>
-#include <proxsuite/proxqp/sparse/model.hpp>
+
 #include <pybind11/pybind11.h>
 #include <pybind11/eigen.h>
+#include <pybind11/operators.h>
+
+#include <proxsuite/proxqp/dense/model.hpp>
+#include <proxsuite/proxqp/sparse/model.hpp>
 #include <proxsuite/proxqp/dense/utils.hpp>
+#include <proxsuite/serialization/archive.hpp>
+#include <proxsuite/serialization/eigen.hpp>
+#include <proxsuite/serialization/model.hpp>
 
 namespace proxsuite {
 namespace proxqp {
@@ -34,7 +40,21 @@ exposeDenseModel(pybind11::module_ m)
     .def_readonly("n_total", &Model<T>::n_total)
     .def("is_valid",
          &Model<T>::is_valid,
-         "Check if model is containing valid data.");
+         "Check if model is containing valid data.")
+    .def(pybind11::self == pybind11::self)
+    .def(pybind11::self != pybind11::self)
+    .def(pybind11::pickle(
+
+      [](const proxsuite::proxqp::dense::Model<T>& model) {
+        return pybind11::bytes(proxsuite::serialization::saveToString(model));
+      },
+      [](pybind11::bytes& s) {
+        // create qp model which will be updated by loaded data
+        proxsuite::proxqp::dense::Model<T> model(1, 1, 1);
+        proxsuite::serialization::loadFromString(model, s);
+
+        return model;
+      }));
 }
 } // namespace python
 } // namespace dense

bindings/python/src/expose-qpobject.hpp

@@ -2,13 +2,16 @@
 // Copyright (c) 2022 INRIA
 //
 
-#include <proxsuite/proxqp/dense/wrapper.hpp>
-#include <proxsuite/proxqp/sparse/wrapper.hpp>
-#include <proxsuite/proxqp/status.hpp>
 #include <pybind11/pybind11.h>
 #include <pybind11/eigen.h>
 #include <pybind11/stl.h>
 
+#include <proxsuite/proxqp/dense/wrapper.hpp>
+#include <proxsuite/proxqp/sparse/wrapper.hpp>
+#include <proxsuite/proxqp/status.hpp>
+#include <proxsuite/serialization/archive.hpp>
+#include <proxsuite/serialization/wrapper.hpp>
+
 namespace proxsuite {
 namespace proxqp {
 using proxsuite::linalg::veg::isize;
@@ -114,7 +117,20 @@ 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)
+    .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;
+      }));
+  ;
 }
 } // namespace python
 } // namespace dense

bindings/python/src/expose-results.hpp

@@ -4,6 +4,10 @@
 #include <proxsuite/proxqp/results.hpp>
 #include <pybind11/pybind11.h>
 #include <pybind11/eigen.h>
+#include <pybind11/operators.h>
+
+#include <proxsuite/serialization/archive.hpp>
+#include <proxsuite/serialization/results.hpp>
 
 #include "helpers.hpp"
 #include "optional.hpp"
@@ -61,7 +65,20 @@ exposeResults(pybind11::module_ m)
       Results<T>,
       z,
       "The dual solution associated to the inequality constraints.")
-    .def_readwrite("info", &Results<T>::info);
+    .def_readwrite("info", &Results<T>::info)
+    .def(pybind11::self == pybind11::self)
+    .def(pybind11::self != pybind11::self)
+    .def(pybind11::pickle(
+
+      [](const Results<T>& results) {
+        return pybind11::bytes(proxsuite::serialization::saveToString(results));
+      },
+      [](pybind11::bytes& s) {
+        Results<T> results;
+        proxsuite::serialization::loadFromString(results, s);
+        return results;
+      }));
+  ;
 }
 } // namespace python
 } // namespace proxqp

bindings/python/src/expose-settings.hpp

@@ -1,10 +1,14 @@
 //
 // Copyright (c) 2022 INRIA
 //
-#include <proxsuite/proxqp/settings.hpp>
-#include <proxsuite/proxqp/status.hpp>
 #include <pybind11/pybind11.h>
 #include <pybind11/eigen.h>
+#include <pybind11/operators.h>
+
+#include <proxsuite/proxqp/settings.hpp>
+#include <proxsuite/proxqp/status.hpp>
+#include <proxsuite/serialization/archive.hpp>
+#include <proxsuite/serialization/settings.hpp>
 
 namespace proxsuite {
 namespace proxqp {
@@ -67,7 +71,21 @@ exposeSettings(pybind11::module_ m)
                    &Settings<T>::compute_preconditioner)
     .def_readwrite("update_preconditioner", &Settings<T>::update_preconditioner)
     .def_readwrite("verbose", &Settings<T>::verbose)
-    .def_readwrite("bcl_update", &Settings<T>::bcl_update);
+    .def_readwrite("bcl_update", &Settings<T>::bcl_update)
+    .def(pybind11::self == pybind11::self)
+    .def(pybind11::self != pybind11::self)
+    .def(pybind11::pickle(
+
+      [](const Settings<T>& settings) {
+        return pybind11::bytes(
+          proxsuite::serialization::saveToString(settings));
+      },
+      [](pybind11::bytes& s) {
+        Settings<T> settings;
+        proxsuite::serialization::loadFromString(settings, s);
+        return settings;
+      }));
+  ;
 }
 } // namespace python
 } // namespace proxqp

external/cereal

@@ -119,6 +119,27 @@ struct Model
 #undef PROXSUITE_CHECK_SIZE
   }
 };
+
+template<typename T>
+bool
+operator==(const Model<T>& model1, const Model<T>& model2)
+{
+  bool value = model1.dim == model2.dim && model1.n_eq == model2.n_eq &&
+               model1.n_in == model2.n_in && model1.n_total == model2.n_total &&
+               model1.H == model2.H && model1.g == model2.g &&
+               model1.A == model2.A && model1.b == model2.b &&
+               model1.C == model2.C && model1.l == model2.l &&
+               model1.u == model2.u;
+  return value;
+}
+
+template<typename T>
+bool
+operator!=(const Model<T>& model1, const Model<T>& model2)
+{
+  return !(model1 == model2);
+}
+
 } // namespace dense
 } // namespace proxqp
 } // namespace proxsuite

include/proxsuite/proxqp/dense/model.hpp

@@ -451,6 +451,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