diff options
Diffstat (limited to 'help/en_US/symphonymat.xml')
| -rw-r--r-- | help/en_US/symphonymat.xml | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/help/en_US/symphonymat.xml b/help/en_US/symphonymat.xml index 68ec072..33ed973 100644 --- a/help/en_US/symphonymat.xml +++ b/help/en_US/symphonymat.xml @@ -53,15 +53,15 @@ <varlistentry><term>ub :</term> <listitem><para> Upper bounds, specified as a vector or array of double. ub represents the upper bounds elementwise in lb ≤ x ≤ ub.</para></listitem></varlistentry> <varlistentry><term>options :</term> - <listitem><para> a list containing the the parameters to be set.</para></listitem></varlistentry> + <listitem><para> a list containing the parameters to be set.</para></listitem></varlistentry> <varlistentry><term>xopt :</term> <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 function value at x</para></listitem></varlistentry> + <listitem><para> a double, the value of the function at x.</para></listitem></varlistentry> <varlistentry><term>status :</term> - <listitem><para> status flag returned from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded.</para></listitem></varlistentry> + <listitem><para> status flag returned from symphony. See below for details.</para></listitem></varlistentry> <varlistentry><term>output :</term> - <listitem><para> The output data structure contains detailed information about the optimization process. This version only contains number of iterations.</para></listitem></varlistentry> + <listitem><para> The output data structure contains detailed information about the optimization process. See below for details.</para></listitem></varlistentry> </variablelist> </refsection> @@ -86,6 +86,25 @@ Search the minimum or maximum of a constrained mixed integer linear programming The routine calls SYMPHONY written in C by gateway files for the actual computation. </para> <para> +The status allows to know the status of the optimization which is given back by Ipopt. +<itemizedlist> +<listitem>status=227 : Optimal Solution Found </listitem> +<listitem>status=228 : Maximum CPU Time exceeded.</listitem> +<listitem>status=229 : Maximum Number of Node Limit Exceeded.</listitem> +<listitem>status=230 : Maximum Number of Iterations Limit Exceeded.</listitem> +</itemizedlist> + </para> + <para> +For more details on status see the symphony documentation, go to http://www.coin-or.org/SYMPHONY/man-5.6/ + </para> + <para> +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +<itemizedlist> +<listitem>output.iterations: The number of iterations performed during the search</listitem> +</itemizedlist> + </para> + <para> </para> </refsection> |