* Bug #9691 fixed - "imp" option of optim was poorly documented. 82/11282/1
Charlotte HECQUET [Tue, 16 Apr 2013 09:40:13 +0000 (11:40 +0200)]
Change-Id: I589cdbabf7d60cb435ed26728f867e0f097161cd

scilab/CHANGES_5.5.X
scilab/modules/optimization/help/en_US/optim.xml

index a1ed92e..9910165 100644 (file)
@@ -77,6 +77,8 @@ Bug fixes
 
 * Bug #9059 fixed - tbx_build_macros and genlib do not stop on error.
 
+* Bug #9691 fixed - "imp" option of optim was poorly documented.
+
 * Bug #10862 fixed - Add a without internet connection installation
                      global configuration on the installer
 
index 94264bf..93a1385 100644 (file)
                 <term>"imp=iflag"</term>
                 <listitem>
                     <para>named argument used to set the trace mode (default
-                        <literal>imp=0</literal>). The available values for
-                        <literal>iflag</literal> are <literal>imp=0,1,2 and
-                            &gt;2
-                        </literal>
-                        .
+                        <literal>imp=0</literal>, which prints no messages). If <varname>imp</varname>
+                        is greater or equal to 1, more information are printed, depending on the
+                        algorithm chosen. More precisely:
                     </para>
                     <itemizedlist>
                         <listitem>
-                            <para>iflag=0: nothing (except errors) is reported (this is the
-                                default),
-                            </para>
+                            <para><literal>"qn"</literal> without constraints: from <literal>iflag=1</literal>
+                            to <literal>iflag=3</literal>.</para>
+                            <itemizedlist>
+                                <listitem>
+                                    <para><literal>iflag>=1</literal>: initial and final print,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=2</literal>: one line per iteration (number of iterations,
+                                    number of calls to f, value of f),</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=3</literal>: extra information on line searches.</para>
+                                </listitem>
+                            </itemizedlist>
+                        </listitem>
+                        <listitem>
+                            <para><literal>"qn"</literal> with bounds constraints: from <literal>iflag=1</literal>
+                            to <literal>iflag=4</literal>.</para>
+                            <itemizedlist>
+                                <listitem>
+                                    <para><literal>iflag>=1</literal>: initial and final print,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=2</literal>: one line per iteration (number of iterations,
+                                    number of calls to f, value of f),</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=3</literal>: extra information on line searches.</para>
+                                </listitem>
+                            </itemizedlist>
                         </listitem>
                         <listitem>
-                            <para>iflag=1: initial and final reports,</para>
+                            <para><literal>"gc"</literal> without constraints: from <literal>iflag=1</literal>
+                            to <literal>iflag=5</literal>.</para>
+                            <itemizedlist>
+                                <listitem>
+                                    <para><literal>iflag>=1</literal> and <literal>iflag>=2</literal>: initial and final print,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag=3</literal>: one line per iteration (number of iterations,
+                                    number of calls to f, value of f),</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=4</literal>: extra information on lines searches.</para>
+                                </listitem>
+                            </itemizedlist> 
                         </listitem>
                         <listitem>
-                            <para>iflag=2: adds a report per iteration,</para>
+                            <para><literal>"gc"</literal> with bounds constraints: from <literal>iflag=1</literal>
+                            to <literal>iflag=3</literal>.</para>
+                            <itemizedlist>
+                                <listitem>
+                                    <para><literal>iflag>=1</literal>: initial and final print,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=2</literal>: one print per iteration,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag=3</literal>: extra information.</para>
+                                </listitem>
+                            </itemizedlist>
                         </listitem>
                         <listitem>
-                            <para>iflag&gt;2: add reports on linear search.</para>
+                            <para><literal>"nd"</literal> with bounds constraints: from <literal>iflag=1</literal>
+                            to <literal>iflag=8</literal>.</para>
+                            <itemizedlist>
+                                <listitem>
+                                    <para><literal>iflag>=1</literal>: initial and final print,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=2</literal>: one print on each convergence,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=3</literal>: one print per iteration,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=4</literal>: line search,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=5</literal>: various tolerances,</para>
+                                </listitem>
+                                <listitem>
+                                    <para><literal>iflag>=6</literal>: weight and information on the computation of direction.</para>
+                                </listitem>
+                            </itemizedlist>
                         </listitem>
                     </itemizedlist>
                 </listitem>