Merge pull request #250 from jcarpent/devel

Update default value for update_preconditioner

Author: jcarpent

bindings/python/src/expose-qpobject.hpp

@@ -175,7 +175,7 @@ exposeQpObjectDense(pybind11::module_ m)
       pybind11::arg_v("u", nullopt, "lower inequality constraint vector"),
       pybind11::arg_v(
         "update_preconditioner",
-        true,
+        false,
         "update the preconditioner considering new matrices entries for "
         "reducing ill-conditioning and speeding up solver execution. If set up "
         "to false, use previous derived preconditioner."),
@@ -214,7 +214,7 @@ exposeQpObjectDense(pybind11::module_ m)
         "u_box", nullopt, "lower box inequality constraint vector"),
       pybind11::arg_v(
         "update_preconditioner",
-        true,
+        false,
         "update the preconditioner considering new matrices entries for "
         "reducing ill-conditioning and speeding up solver execution. If set up "
         "to false, use previous derived preconditioner."),
@@ -312,7 +312,7 @@ exposeQpObjectSparse(pybind11::module_ m)
          pybind11::arg_v("u", nullopt, "lower inequality constraint vector"),
          pybind11::arg_v(
            "update_preconditioner",
-           true,
+           false,
            "update the preconditioner or re-use previous derived for reducing "
            "ill-conditioning and speeding up solver execution."),
          pybind11::arg_v("rho", nullopt, "primal proximal parameter"),

cmake-module

@@ -397,7 +397,7 @@ In this table you have on the three columns from left to right: the name of the
 | mu_update_factor                    | 0.1                                | Factor used for updating mu_eq and mu_in.
 | eps_primal_inf                      | 1.E-4                              | Threshold under which primal infeasibility is detected.
 | eps_dual_inf                        | 1.E-4                              | Threshold under which dual infeasibility is detected.
-| update_preconditioner               | True                               | If set to true, the preconditioner will be re-derived with the update method, otherwise it uses previous one.
+| update_preconditioner               | False                              | If set to true, the preconditioner will be re-derived with the update method, otherwise it uses previous one.
 | compute_preconditioner              | True                               | If set to true, the preconditioner will be derived with the init method.
 | alpha_bcl                           | 0.1                                | alpha parameter of the BCL algorithm.
 | beta_bcl                            | 0.9                                | beta parameter of the BCL algorithm.

doc/2-PROXQP_API/2-ProxQP_api.md

@@ -715,7 +715,7 @@ struct QP
               optional<MatRef<T>> C,
               optional<VecRef<T>> l,
               optional<VecRef<T>> u,
-              bool update_preconditioner = true,
+              bool update_preconditioner = false,
               optional<T> rho = nullopt,
               optional<T> mu_eq = nullopt,
               optional<T> mu_in = nullopt)
@@ -821,7 +821,7 @@ struct QP
               optional<VecRef<T>> u,
               optional<VecRef<T>> l_box,
               optional<VecRef<T>> u_box,
-              bool update_preconditioner = true,
+              bool update_preconditioner = false,
               optional<T> rho = nullopt,
               optional<T> mu_eq = nullopt,
               optional<T> mu_in = nullopt)

include/proxsuite/proxqp/dense/wrapper.hpp

@@ -170,9 +170,9 @@ struct Settings
    * @param initial_guess sets the initial guess option for initilizing x, y
    * and z.
    * @param update_preconditioner If set to true, the preconditioner will be
-   * re-derived with the update method.
+   * re-computed when calling the update method.
    * @param compute_preconditioner If set to true, the preconditioner will be
-   * derived with the init method.
+   * computed with the init method.
    * @param compute_timings If set to true, timings will be computed by the
    * solver (setup time, solving time, and run time = setup time + solving
    * time).
@@ -228,7 +228,7 @@ struct Settings
                                           // EQUALITY_CONSTRAINED_INITIAL_GUESS,
                                           // as most often we run only
                                           // once a problem
-    bool update_preconditioner = true,
+    bool update_preconditioner = false,
     bool compute_preconditioner = true,
     bool compute_timings = false,
     bool check_duality_gap = false,

include/proxsuite/proxqp/settings.hpp

@@ -351,7 +351,7 @@ struct QP
               const optional<SparseMat<T, I>> C,
               optional<VecRef<T>> l,
               optional<VecRef<T>> u,
-              bool update_preconditioner = true,
+              bool update_preconditioner = false,
               optional<T> rho = nullopt,
               optional<T> mu_eq = nullopt,
               optional<T> mu_in = nullopt)