Browse Source

fixed doc to reflect possible issue

Former-commit-id: 6d29cb5731e4d9b91a09fdc57698c57c90c8235e
Alec Jacobson 9 years ago
parent
commit
9887dfb451
1 changed files with 3 additions and 1 deletions
  1. 3 1
      include/igl/lim/lim.h

+ 3 - 1
include/igl/lim/lim.h

@@ -61,7 +61,9 @@ namespace igl
     //                   mesh
     //--------------------------------------------------------------------------
     // Return values:
-    //  1 : Successful optimization with fulfilled tolerance
+    //  1 : Optimization deemed successful because either (a) it stagnated
+    //    (very step size) or (b) positional constraints were satisfied. (re:
+    //    https://github.com/libigl/libigl/issues/79 )
     // -1 : Max iteration reached before tolerance was fulfilled
     // -2 : not feasible -> has inverted elements (may want to decrease eps?)