Browse Source

fix 2025 with documentation [ci skip]

Alec Jacobson 2 years ago
parent
commit
e5e7d8a76a
1 changed files with 7 additions and 0 deletions
  1. 7 0
      include/igl/linprog.h

+ 7 - 0
include/igl/linprog.h

@@ -25,6 +25,12 @@ namespace igl
   /// @param[in] b  #A list of linear constraint right-hand sides
   /// @param[in] k  number of inequality constraints as first rows of A,b
   /// @param[out] x  #x solution vector
+  /// @return false on failure or detected infeasibility, returns true on termination
+  ///
+  /// \note It appears that this implementation does not detect all infeasibile
+  /// problems (e.g., https://github.com/libigl/libigl/issues/2051). Therefor,
+  /// it's worth double-checking that the output actually satisfies the
+  /// constraints even if the return value is `true`.
   IGL_INLINE bool linprog(
     const Eigen::VectorXd & c,
     const Eigen::MatrixXd & A,
@@ -44,6 +50,7 @@ namespace igl
   /// @param[in] B  #B by #x matrix of linear equality constraint coefficients
   /// @param[in] c  #B list of linear constraint right-hand sides
   /// @param[out] x  #x solution vector
+  /// @return false on failure or detected infeasibility, returns true on termination
   ///
   IGL_INLINE bool linprog(
     const Eigen::VectorXd & f,