From dad86bd42cdc2a0e56df9e0591879e5d26fd56fa Mon Sep 17 00:00:00 2001
From: Harpreet
Date: Tue, 5 Jan 2016 12:22:43 +0530
Subject: constrviolation and licence file added

---
 help/en_US/symphony.xml | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'help/en_US/symphony.xml')

diff --git a/help/en_US/symphony.xml b/help/en_US/symphony.xml
index da156ce..68f1742 100644
--- a/help/en_US/symphony.xml
+++ b/help/en_US/symphony.xml
@@ -56,15 +56,15 @@
    <varlistentry><term>objSense :</term>
       <listitem><para> The sense (maximization/minimization) of the objective. Use 1(sym_minimize ) or -1 (sym_maximize) here.</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>
 
@@ -88,6 +88,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>
 
-- 
cgit