* Bug #12019 fixed - In the help of eigs function, NEV was unclear. 93/10493/4
Charlotte HECQUET [Fri, 15 Feb 2013 13:37:21 +0000 (14:37 +0100)]
Change-Id: I45f4be32e5540ec10e45f38b4dec868cf6182a5b

scilab/CHANGES_5.4.X
scilab/modules/arnoldi/help/en_US/eigs.xml

index e7a0a1d..bc4f65a 100644 (file)
@@ -298,6 +298,8 @@ Bug fixes
 
 * Bug #12003 fixed - Fix a typo in the spreadsheet module.
 
+* Bug #12019 fixed - In the help of eigs function, NEV was unclear.
+
 * Bug #12022 fixed - ftuneq had a bad example.
 
 * Bug #12028 fixed - The pair drawlater/drawnow did not work as expected.
index f545ebb..94ec88d 100644 (file)
@@ -185,47 +185,52 @@ function y = A ( x )
                     <itemizedlist>
                         <listitem>
                             <para>
-                                <literal>'LM'</literal> compute the NEV largest in magnitude eigenvalues (by default).
+                                <literal>'LM'</literal> compute the <varname>k</varname> largest in magnitude eigenvalues (by default).
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'SM'</literal> compute the NEV smallest in magnitude eigenvalues (same as sigma = 0).
+                                <literal>'SM'</literal> compute the <varname>k</varname> smallest in magnitude eigenvalues (same as sigma = 0).
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'LA'</literal> compute the NEV Largest Algebraic eigenvalues, only for real symmetric problems.
+                                <literal>'LA'</literal> compute the <varname>k</varname> Largest Algebraic eigenvalues, only for real symmetric problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'SA'</literal> compute the NEV Smallest Algebraic eigenvalues, only for real symmetric problems.
+                                <literal>'SA'</literal> compute the <varname>k</varname> Smallest Algebraic eigenvalues, only for real symmetric problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'BE'</literal> compute NEV eigenvalues, half from each end of the spectrum, only for real symmetric problems.
+                                <literal>'BE'</literal> compute <varname>k</varname> eigenvalues, half from each end of the spectrum, only for real 
+                                symmetric problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'LR'</literal> compute the NEV eigenvalues of Largest Real part, only for real non-symmetric or complex problems.
+                                <literal>'LR'</literal> compute the <varname>k</varname> eigenvalues of Largest Real part, only for real non-symmetric or 
+                                complex problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'SR'</literal> compute the NEV eigenvalues of Smallest Real part, only for real non-symmetric or complex problems.
+                                <literal>'SR'</literal> compute the <varname>k</varname> eigenvalues of Smallest Real part, only for real non-symmetric or 
+                                complex problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'LI'</literal> compute the NEV eigenvalues of Largest Imaginary part, only for real non-symmetric or complex problems.
+                                <literal>'LI'</literal> compute the <varname>k</varname> eigenvalues of Largest Imaginary part, only for real non-symmetric 
+                                or complex problems.
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                <literal>'SI'</literal> compute the NEV eigenvalues of Smallest Imaginary part, only for real non-symmetric or complex problems.
+                                <literal>'SI'</literal> compute the <varname>k</varname> eigenvalues of Smallest Imaginary part, only for real non-symmetric 
+                                or complex problems.
                             </para>
                         </listitem>
                     </itemizedlist>