Browse Source

added a line documenting Z as being an optional input paramter of initial guess values

Former-commit-id: bceeb48c2e84781f1d257292dcc5e84cf1ed8262
Yotam Gingold 11 years ago
parent
commit
5dedc4fb86
1 changed files with 1 additions and 0 deletions
  1. 1 0
      include/igl/active_set.h

+ 1 - 0
include/igl/active_set.h

@@ -38,6 +38,7 @@ namespace igl
   //   lx  n by 1 list of lower bounds [] implies -Inf
   //   lx  n by 1 list of lower bounds [] implies -Inf
   //   ux  n by 1 list of upper bounds [] implies Inf
   //   ux  n by 1 list of upper bounds [] implies Inf
   //   params  struct of additional parameters (see below)
   //   params  struct of additional parameters (see below)
+  //   Z, if not empty, is taken to be an n by 1 list of initial guess values
   // Outputs:
   // Outputs:
   //   Z  n by 1 list of solution values
   //   Z  n by 1 list of solution values
   // Returns true on success, false on error
   // Returns true on success, false on error