summaryrefslogtreecommitdiff
path: root/help/en_US/qpipoptmat.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/qpipoptmat.xml')
-rw-r--r--help/en_US/qpipoptmat.xml12
1 files changed, 10 insertions, 2 deletions
diff --git a/help/en_US/qpipoptmat.xml b/help/en_US/qpipoptmat.xml
index 642971d..d8a9ac3 100644
--- a/help/en_US/qpipoptmat.xml
+++ b/help/en_US/qpipoptmat.xml
@@ -62,8 +62,6 @@
<listitem><para> a vector of double, the computed solution of the optimization problem.</para></listitem></varlistentry>
<varlistentry><term>fopt :</term>
<listitem><para> a double, the value of the function at x.</para></listitem></varlistentry>
- <varlistentry><term>residual :</term>
- <listitem><para> a vector of double, solution residuals returned as the vector d-C*x.</para></listitem></varlistentry>
<varlistentry><term>exitflag :</term>
<listitem><para> The exit status. See below for details.</para></listitem></varlistentry>
<varlistentry><term>output :</term>
@@ -93,6 +91,16 @@ Search the minimum of a constrained linear quadratic optimization problem specif
The routine calls Ipopt for solving the quadratic problem, 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>