sleipnirgroup-jormungandr 0.5.6.dev7__tar.gz → 0.5.6.dev8__tar.gz

{sleipnirgroup_jormungandr-0.5.6.dev7 → sleipnirgroup_jormungandr-0.5.6.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sleipnirgroup-jormungandr
-Version: 0.5.6.dev7
+Version: 0.5.6.dev8
 Summary: Reverse mode autodiff library and NLP solver DSL
 License-Expression: BSD-3-Clause
 License-File: LICENSE.txt

{sleipnirgroup_jormungandr-0.5.6.dev7 → sleipnirgroup_jormungandr-0.5.6.dev8}/include/sleipnir/optimization/solver/util/is_locally_infeasible.hpp

@@ -12,10 +12,8 @@ namespace slp {
 /// Returns true if the problem's equality constraints are locally infeasible.
 ///
 /// @tparam Scalar Scalar type.
-/// @param A_e The problem's equality constraint Jacobian Aₑ(x) evaluated at the
-///     current iterate.
-/// @param c_e The problem's equality constraints cₑ(x) evaluated at the current
-///     iterate.
+/// @param A_e Equality constraint Jacobian Aₑ(x).
+/// @param c_e Equality constraints cₑ(x).
 template <typename Scalar>
 bool is_equality_locally_infeasible(
     const Eigen::SparseMatrix<Scalar>& A_e,
@@ -33,10 +31,8 @@ bool is_equality_locally_infeasible(
 /// Returns true if the problem's inequality constraints are locally infeasible.
 ///
 /// @tparam Scalar Scalar type.
-/// @param A_i The problem's inequality constraint Jacobian Aᵢ(x) evaluated at
-///     the current iterate.
-/// @param c_i The problem's inequality constraints cᵢ(x) evaluated at the
-///     current iterate.
+/// @param A_i Inequality constraint Jacobian Aᵢ(x).
+/// @param c_i Inequality constraints cᵢ(x).
 template <typename Scalar>
 bool is_inequality_locally_infeasible(
     const Eigen::SparseMatrix<Scalar>& A_i,

{sleipnirgroup_jormungandr-0.5.6.dev7 → sleipnirgroup_jormungandr-0.5.6.dev8}/include/sleipnir/optimization/solver/util/kkt_error.hpp

@@ -24,8 +24,8 @@ enum class KKTErrorType {
 /// Returns the KKT error for Newton's method.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param g Gradient of the cost function ∇f.
+/// @tparam T Type of KKT error to compute.
+/// @param g Cost function gradient ∇f.
 template <typename Scalar, KKTErrorType T>
 Scalar kkt_error(const Eigen::Vector<Scalar, Eigen::Dynamic>& g) {
   // The KKT conditions from docs/algorithms.md:
@@ -42,12 +42,10 @@ Scalar kkt_error(const Eigen::Vector<Scalar, Eigen::Dynamic>& g) {
 /// Returns the KKT error for Sequential Quadratic Programming.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param g Gradient of the cost function ∇f.
-/// @param A_e The problem's equality constraint Jacobian Aₑ(x) evaluated at the
-///     current iterate.
-/// @param c_e The problem's equality constraints cₑ(x) evaluated at the current
-///     iterate.
+/// @tparam T Type of KKT error to compute.
+/// @param g Cost function gradient ∇f.
+/// @param A_e Equality constraint Jacobian Aₑ(x).
+/// @param c_e Equality constraints cₑ(x).
 /// @param y Equality constraint dual variables.
 template <typename Scalar, KKTErrorType T>
 Scalar kkt_error(const Eigen::Vector<Scalar, Eigen::Dynamic>& g,
@@ -81,16 +79,12 @@ Scalar kkt_error(const Eigen::Vector<Scalar, Eigen::Dynamic>& g,
 /// Returns the KKT error for the interior-point method.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param g Gradient of the cost function ∇f.
-/// @param A_e The problem's equality constraint Jacobian Aₑ(x) evaluated at the
-///     current iterate.
-/// @param c_e The problem's equality constraints cₑ(x) evaluated at the current
-///     iterate.
-/// @param A_i The problem's inequality constraint Jacobian Aᵢ(x) evaluated at
-///     the current iterate.
-/// @param c_i The problem's inequality constraints cᵢ(x) evaluated at the
-///     current iterate.
+/// @tparam T Type of KKT error to compute.
+/// @param g Cost function gradient ∇f.
+/// @param A_e Equality constraint Jacobian Aₑ(x).
+/// @param c_e Equality constraints cₑ(x).
+/// @param A_i Inequality constraint Jacobian Aᵢ(x).
+/// @param c_i Inequality constraints cᵢ(x).
 /// @param s Inequality constraint slack variables.
 /// @param y Equality constraint dual variables.
 /// @param z Inequality constraint dual variables.
@@ -154,9 +148,9 @@ Scalar kkt_error(const Eigen::Vector<Scalar, Eigen::Dynamic>& g,
 /// Returns the unscaled KKT error for Newton's method.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param scaling The problem scaling factors.
-/// @param g Gradient of the scaled cost function d_f·∇f.
+/// @tparam T Type of KKT error to compute.
+/// @param scaling Problem scaling.
+/// @param g Scaled cost function gradient d_f·∇f.
 template <typename Scalar, KKTErrorType T>
 Scalar unscaled_kkt_error(const ProblemScaling<Scalar>& scaling,
                           const Eigen::Vector<Scalar, Eigen::Dynamic>& g) {
@@ -174,13 +168,11 @@ Scalar unscaled_kkt_error(const ProblemScaling<Scalar>& scaling,
 /// Returns the unscaled KKT error for Sequential Quadratic Programming.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param scaling The problem scaling factors.
-/// @param g Gradient of the scaled cost function d_f·∇f.
-/// @param A_e The problem's scaled equality constraint Jacobian D_cₑ·Aₑ(x)
-///     evaluated at the current iterate.
-/// @param c_e The problem's scaled equality constraints D_cₑ·cₑ(x) evaluated
-///     at the current iterate.
+/// @tparam T Type of KKT error to compute.
+/// @param scaling Problem scaling.
+/// @param g Scaled cost function gradient d_f·∇f.
+/// @param A_e Scaled equality constraint Jacobian D_cₑ·Aₑ(x).
+/// @param c_e Scaled equality constraints D_cₑ·cₑ(x).
 /// @param y Scaled equality constraint dual variables.
 template <typename Scalar, KKTErrorType T>
 Scalar unscaled_kkt_error(const ProblemScaling<Scalar>& scaling,
@@ -210,17 +202,13 @@ Scalar unscaled_kkt_error(const ProblemScaling<Scalar>& scaling,
 /// Returns the unscaled KKT error for the interior-point method.
 ///
 /// @tparam Scalar Scalar type.
-/// @tparam T The type of KKT error to compute.
-/// @param scaling The problem scaling factors.
-/// @param g Gradient of the scaled cost function d_f·∇f.
-/// @param A_e The problem's scaled equality constraint Jacobian D_cₑ·Aₑ(x)
-///     evaluated at the current iterate.
-/// @param c_e The problem's scaled equality constraints D_cₑ·cₑ(x) evaluated at
-///     the current iterate.
-/// @param A_i The problem's scaled inequality constraint Jacobian D_cᵢ·Aᵢ(x)
-///     evaluated at the current iterate.
-/// @param c_i The problem's scaled inequality constraints D_cᵢ·cᵢ(x) evaluated
-///     at the current iterate.
+/// @tparam T Type of KKT error to compute.
+/// @param scaling Problem scaling.
+/// @param g Scaled cost function gradient d_f·∇f.
+/// @param A_e Scaled equality constraint Jacobian D_cₑ·Aₑ(x).
+/// @param c_e Scaled equality constraints D_cₑ·cₑ(x).
+/// @param A_i Scaled inequality constraint Jacobian D_cᵢ·Aᵢ(x).
+/// @param c_i Scaled inequality constraints D_cᵢ·cᵢ(x).
 /// @param s Scaled inequality constraint slack variables.
 /// @param y Scaled equality constraint dual variables.
 /// @param z Scaled inequality constraint dual variables.

{sleipnirgroup_jormungandr-0.5.6.dev7 → sleipnirgroup_jormungandr-0.5.6.dev8}/include/sleipnir/optimization/solver/util/lagrange_multiplier_estimate.hpp

@@ -27,9 +27,8 @@ struct LagrangeMultiplierEstimate {
 /// Estimates Lagrange multipliers for SQP.
 ///
 /// @tparam Scalar Scalar type.
-/// @param g Gradient of the cost function ∇f.
-/// @param A_e The problem's equality constraint Jacobian Aₑ(x) evaluated at the
-///     current iterate.
+/// @param g Cost function gradient ∇f.
+/// @param A_e Equality constraint Jacobian Aₑ(x).
 template <typename Scalar>
 Eigen::Vector<Scalar, Eigen::Dynamic> lagrange_multiplier_estimate(
     const Eigen::SparseVector<Scalar>& g,
@@ -47,11 +46,9 @@ Eigen::Vector<Scalar, Eigen::Dynamic> lagrange_multiplier_estimate(
 /// Estimates Lagrange multipliers for interior-point method.
 ///
 /// @tparam Scalar Scalar type.
-/// @param g Gradient of the cost function ∇f.
-/// @param A_e The problem's equality constraint Jacobian Aₑ(x) evaluated at the
-///     current iterate.
-/// @param A_i The problem's inequality constraint Jacobian Aᵢ(x) evaluated at
-///     the current iterate.
+/// @param g Cost function gradient ∇f.
+/// @param A_e Equality constraint Jacobian Aₑ(x).
+/// @param A_i Inequality constraint Jacobian Aᵢ(x).
 /// @param s Inequality constraint slack variables.
 /// @param μ Barrier parameter.
 template <typename Scalar>

{sleipnirgroup_jormungandr-0.5.6.dev7 → sleipnirgroup_jormungandr-0.5.6.dev8}/python/src/sleipnir/__init__.py

@@ -2,4 +2,4 @@
 
 from ._sleipnir import *
 
-__version__ = "0.5.6.dev7"
+__version__ = "0.5.6.dev8"