sleipnirgroup-jormungandr 0.0.1.dev462__tar.gz → 0.0.1.dev464__tar.gz

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sleipnirgroup-jormungandr
-Version: 0.0.1.dev462
+Version: 0.0.1.dev464
 Summary: A linearity-exploiting sparse nonlinear constrained optimization problem solver that uses the interior-point method.
 License: Copyright (c) Sleipnir contributors
         

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/include/sleipnir/optimization/problem.hpp

@@ -278,7 +278,7 @@ class SLEIPNIR_DLLEXPORT Problem {
                    [[maybe_unused]] bool spy = false);
 
   /**
-   * Adds a callback to be called at each solver iteration.
+   * Adds a callback to be called at the beginning of each solver iteration.
    *
    * The callback for this overload should return void.
    *
@@ -297,7 +297,7 @@ class SLEIPNIR_DLLEXPORT Problem {
   }
 
   /**
-   * Adds a callback to be called at each solver iteration.
+   * Adds a callback to be called at the beginning of each solver iteration.
    *
    * The callback for this overload should return bool.
    *

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/include/sleipnir/optimization/solver/interior_point.hpp

@@ -212,7 +212,8 @@ where f(x) is the cost function, cₑ(x) are the equality constraints, and cᵢ(
 are the inequality constraints.
 
 @param[in] matrix_callbacks Matrix callbacks.
-@param[in] iteration_callbacks The list of iteration callbacks.
+@param[in] iteration_callbacks The list of callbacks to call at the beginning of
+  each iteration.
 @param[in] options Solver options.
 @param[in,out] x The initial guess and output location for the decision
   variables.

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/include/sleipnir/optimization/solver/newton.hpp

@@ -97,7 +97,8 @@ A nonlinear program has the form:
 where f(x) is the cost function.
 
 @param[in] matrix_callbacks Matrix callbacks.
-@param[in] iteration_callbacks The list of iteration callbacks.
+@param[in] iteration_callbacks The list of callbacks to call at the beginning of
+  each iteration.
 @param[in] options Solver options.
 @param[in,out] x The initial guess and output location for the decision
   variables.

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/include/sleipnir/optimization/solver/sqp.hpp

@@ -155,7 +155,8 @@ subject to cₑ(x) = 0
 where f(x) is the cost function and cₑ(x) are the equality constraints.
 
 @param[in] matrix_callbacks Matrix callbacks.
-@param[in] iteration_callbacks The list of iteration callbacks.
+@param[in] iteration_callbacks The list of callbacks to call at the beginning of
+  each iteration.
 @param[in] options Solver options.
 @param[in,out] x The initial guess and output location for the decision
   variables.

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/jormungandr/cpp/docstrings.hpp

@@ -693,7 +693,8 @@ mathematical form and it'll be converted for them.)doc";
 static const char *__doc_slp_Problem_Problem = R"doc(Construct the optimization problem.)doc";
 
 static const char *__doc_slp_Problem_add_callback =
-R"doc(Adds a callback to be called at each solver iteration.
+R"doc(Adds a callback to be called at the beginning of each solver
+iteration.
 
 The callback for this overload should return void.
 
@@ -701,7 +702,8 @@ Parameter ``callback``:
     The callback.)doc";
 
 static const char *__doc_slp_Problem_add_callback_2 =
-R"doc(Adds a callback to be called at each solver iteration.
+R"doc(Adds a callback to be called at the beginning of each solver
+iteration.
 
 The callback for this overload should return bool.
 
@@ -3098,7 +3100,7 @@ Parameter ``matrix_callbacks``:
     Matrix callbacks.
 
 Parameter ``iteration_callbacks``:
-    The list of iteration callbacks.
+    The list of callbacks to call at the beginning of each iteration.
 
 Parameter ``options``:
     Solver options.
@@ -3149,7 +3151,7 @@ Parameter ``matrix_callbacks``:
     Matrix callbacks.
 
 Parameter ``iteration_callbacks``:
-    The list of iteration callbacks.
+    The list of callbacks to call at the beginning of each iteration.
 
 Parameter ``options``:
     Solver options.
@@ -3285,7 +3287,7 @@ Parameter ``matrix_callbacks``:
     Matrix callbacks.
 
 Parameter ``iteration_callbacks``:
-    The list of iteration callbacks.
+    The list of callbacks to call at the beginning of each iteration.
 
 Parameter ``options``:
     Solver options.

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "sleipnirgroup-jormungandr"
 description = "A linearity-exploiting sparse nonlinear constrained optimization problem solver that uses the interior-point method."
-version = "0.0.1.dev462"
+version = "0.0.1.dev464"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [ "matplotlib", "numpy", "scipy" ]

{sleipnirgroup_jormungandr-0.0.1.dev462 → sleipnirgroup_jormungandr-0.0.1.dev464}/src/optimization/problem.cpp

@@ -83,6 +83,10 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
   // Solve the optimization problem
   ExitStatus status;
   if (m_equality_constraints.empty() && m_inequality_constraints.empty()) {
+    if (options.diagnostics) {
+      slp::println("\nInvoking Newton solver...\n");
+    }
+
     // Set up Lagrangian Hessian autodiff
     ad_setup_profilers.emplace_back("  ↳ ∇²ₓₓL").start();
     Hessian<Eigen::Lower> H{f, x_ad};
@@ -103,10 +107,6 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
         return false;
       });
     }
-
-    if (options.diagnostics) {
-      slp::println("\nInvoking Newton solver...\n");
-    }
 #endif
 
     // Invoke Newton solver
@@ -125,17 +125,11 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
               return H.value();
             }},
         m_iteration_callbacks, options, x);
-
-#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
-    if (spy) {
-      m_iteration_callbacks.pop_back();
-    }
-#endif
-
+  } else if (m_inequality_constraints.empty()) {
     if (options.diagnostics) {
-      print_autodiff_diagnostics(ad_setup_profilers);
+      slp::println("\nInvoking SQP solver\n");
     }
-  } else if (m_inequality_constraints.empty()) {
+
     VariableMatrix c_e_ad{m_equality_constraints};
 
     // Set up equality constraint Jacobian autodiff
@@ -173,10 +167,6 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
         return false;
       });
     }
-
-    if (options.diagnostics) {
-      slp::println("\nInvoking SQP solver\n");
-    }
 #endif
 
     // Invoke SQP solver
@@ -205,17 +195,11 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
                   return A_e.value();
                 }},
             m_iteration_callbacks, options, x);
-
-#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
-    if (spy) {
-      m_iteration_callbacks.pop_back();
-    }
-#endif
-
+  } else {
     if (options.diagnostics) {
-      print_autodiff_diagnostics(ad_setup_profilers);
+      slp::println("\nInvoking IPM solver...\n");
     }
-  } else {
+
     VariableMatrix c_e_ad{m_equality_constraints};
     VariableMatrix c_i_ad{m_inequality_constraints};
 
@@ -266,10 +250,6 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
         return false;
       });
     }
-
-    if (options.diagnostics) {
-      slp::println("\nInvoking IPM solver...\n");
-    }
 #endif
 
     // Invoke interior-point method solver
@@ -307,23 +287,18 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
               return A_i.value();
             }},
         m_iteration_callbacks, options, x);
+  }
 
 #ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
-    if (spy) {
-      m_iteration_callbacks.pop_back();
-    }
-#endif
-
-    if (options.diagnostics) {
-      print_autodiff_diagnostics(ad_setup_profilers);
-    }
+  if (spy) {
+    m_iteration_callbacks.pop_back();
   }
+#endif
 
-#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
   if (options.diagnostics) {
+    print_autodiff_diagnostics(ad_setup_profilers);
     slp::println("\nExit: {}", to_message(status));
   }
-#endif
 
   // Assign the solution to the original Variable instances
   VariableMatrix{m_decision_variables}.set_value(x);
@@ -332,7 +307,6 @@ ExitStatus Problem::solve(const Options& options, [[maybe_unused]] bool spy) {
 }
 
 void Problem::print_exit_conditions([[maybe_unused]] const Options& options) {
-#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
   // Print possible exit conditions
   slp::println("User-configured exit conditions:");
   slp::println("  ↳ error below {}", options.tolerance);
@@ -345,11 +319,9 @@ void Problem::print_exit_conditions([[maybe_unused]] const Options& options) {
   if (std::isfinite(options.timeout.count())) {
     slp::println("  ↳ {} elapsed", options.timeout);
   }
-#endif
 }
 
 void Problem::print_problem_analysis() {
-#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
   constexpr std::array types{"no", "constant", "linear", "quadratic",
                              "nonlinear"};
 
@@ -395,7 +367,6 @@ void Problem::print_problem_analysis() {
     slp::println("{} inequality constraints", m_inequality_constraints.size());
   }
   print_constraint_types(m_inequality_constraints);
-#endif
 }
 
 }  // namespace slp