* Bug #12020 fixed - Default value of ncv in eigs function was not documented. 96/10496/2
Charlotte HECQUET [Fri, 15 Feb 2013 14:48:51 +0000 (15:48 +0100)]
Change-Id: Iaf4a94edd033b0990f062441a99c6bc91fd39564

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

index 0d16c71..76b2f25 100644 (file)
@@ -307,6 +307,8 @@ Bug fixes
 
 * Bug #12004 fixed - Add "Configuring scaling factor" in the karmarkar help page.
 
+* Bug #12020 fixed - Default value of ncv in eigs  function was not documented.
+
 * Bug #12022 fixed - ftuneq had a bad example.
 
 * Bug #12028 fixed - The pair drawlater/drawnow did not work as expected.
index 94ec88d..e21c2c3 100644 (file)
@@ -263,8 +263,7 @@ function y = A ( x )
                             <para>
                                 <term>ncv</term>
                                 <para>
-                                    number of Lanzcos basis vectors to use. The <literal>ncv</literal> value must be greater or equal than <literal>2 * k + 1 </literal> for real non-symmetric
-                                    problems. For real symmetric or complex problems, <literal>ncv</literal> must be greater or equal <literal>2 * k </literal>.
+                                    number of Lanzcos basis vectors to use. For real non-symmetric problems, the <literal>ncv</literal> value must be greater or equal than <literal>2 * k + 1 </literal> and, by default, <literal>ncv = min(max(2 * k + 1, 20), nA) </literal>. For real symmetric or complex problems, <literal>ncv</literal> must be greater or equal <literal>2 * k </literal> and, by default, <literal> ncv = min(max(2 * k, 20), nA) </literal> with <literal> nA = size(A, 2) </literal>.
                                 </para>
                             </para>
                         </listitem>