summaryrefslogtreecommitdiff
path: root/help/en_US/lsqnonneg.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/lsqnonneg.xml')
-rw-r--r--help/en_US/lsqnonneg.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/help/en_US/lsqnonneg.xml b/help/en_US/lsqnonneg.xml
index 07cf7e6..a8d7a00 100644
--- a/help/en_US/lsqnonneg.xml
+++ b/help/en_US/lsqnonneg.xml
@@ -71,6 +71,16 @@ Solves nonnegative least-squares curve fitting problems specified by :
The routine calls Ipopt for solving the nonnegative least-squares curve fitting problems, Ipopt is a library written in C++.
</para>
<para>
+The options allows the user to set various parameters of the Optimization problem.
+It should be defined as type "list" and contains the following fields.
+<itemizedlist>
+<listitem>Syntax : options= list("MaxIter", [---], "CpuTime", [---]);</listitem>
+<listitem>MaxIter : a Scalar, containing the Maximum Number of Iteration that the solver should take.</listitem>
+<listitem>CpuTime : a Scalar, containing the Maximum amount of CPU Time that the solver should take.</listitem>
+<listitem>Default Values : options = list("MaxIter", [3000], "CpuTime", [600]);</listitem>
+</itemizedlist>
+ </para>
+ <para>
The exitflag allows to know the status of the optimization which is given back by Ipopt.
<itemizedlist>
<listitem>exitflag=0 : Optimal Solution Found </listitem>