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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sleipnirgroup-jormungandr
-Version: 0.0.1.dev462
+Version: 0.0.1.dev463
 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.dev463}/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.dev463}/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.dev463}/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.dev463}/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.dev463}/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.dev463}/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.dev463"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [ "matplotlib", "numpy", "scipy" ]