* Bug #12882 fixed - Some help pages were not clear. 63/13063/3
A. Khorshidi [Fri, 1 Nov 2013 02:15:20 +0000 (03:15 +0100)]
Change-Id: Ia3078509c744dbdb5000334e5f950b81c08b38f8

scilab/CHANGES_5.5.X
scilab/modules/core/help/en_US/1_keywords/left.xml
scilab/modules/core/help/en_US/variables/predef.xml
scilab/modules/linear_algebra/help/en_US/matrix/det.xml

index ce896ff..d2b2b49 100644 (file)
@@ -46,6 +46,8 @@ Scilab Bug Fixes
 
 * Bug #12769 fixed - xset("window", 1) did not set the current axes.
 
+* Bug #12882 fixed - Some help pages were not clear.
+
 * Bug #12910 fixed - Some typos fixed.
 
 * Bug #12938 fixed - No java compiler was available in Linux binary version.
@@ -95,7 +97,7 @@ Scilab Bug Fixes
 
 * Bug #13014 fixed - Update of the Efficiency inner variable improved in optim_ga.
 
-* Bug #13015 fixed - Computation of Efficiency innver variable improved in optim_ga.
+* Bug #13015 fixed - Computation of Efficiency inner variable improved in optim_ga.
 
 * Bug #13032 fixed - Fixed CMATVIEW help example and created one for CMAT3D.
 
index 7dda5d8..4554ea9 100644 (file)
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>a11,a12,...  </term>
+                <term>a11,a12,... </term>
                 <listitem>
-                    <para>matrix of any compatibles types with compatibles dimensions s1,s2,... : any possible variable name</para>
+                    <para>matrix of any compatible types with compatible dimensions</para>
+                </listitem>
+                <term>s1,s2,... </term>
+                <listitem>
+                    <para>any possible variable name</para>
                 </listitem>
             </varlistentry>
         </variablelist>
             These symbols are also used to denote a multiple left-hand-side for a function call
         </para>
         <para>
-            Inside concatenation brackets blank or comma characters mean "column concatenation", 
+            Inside concatenation brackets blank or comma characters mean "column concatenation",
             semicolon and carriage-return mean "row concatenation".
         </para>
         <para>
-            Note : to avoid confusions it is safer to use comma instead of blank to
-            separate columns.
+            <note>
+                Note : to avoid confusions it is safer to use comma instead of blank to
+                separate columns.
+            </note>
         </para>
         <para>
             Within multiple lhs brackets variable names must be separated by comma.
@@ -41,7 +47,7 @@
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 [6.9,9.64; sqrt(-1) 0]
 [1 +%i  2 -%i  3]
 []
index 71842c9..9cd9d56 100644 (file)
             User may in particular set its own predefined variables in user's startup files 
             <literal>SCIHOME/.scilab</literal> or <literal>SCIHOME/scilab.ini</literal>
         </para>
+        <para>
+            <important>
+                Note that it is not possible to protect a new defined variable by using <code>predef(1)</code>. 
+                This means that to protect a variable, Scilab needs to protect all the variables that have been defined before it.
+                This limitation may disappear with Scilab 6, which will not be stack-designed.
+            </important>
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -65,7 +72,6 @@ predef("clear")
 clear a // works
  ]]></programlisting>
     </refsection>
-    
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
index 0d5d730..10d6965 100644 (file)
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
@@ -27,7 +27,7 @@
             <varlistentry>
                 <term>X</term>
                 <listitem>
-                    <para>real or complex square matrix (full or sparse), polynomial or rational matrix</para>
+                    <para>real or complex square matrix, polynomial or rational matrix.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -47,7 +47,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>det(X)</literal> ( <literal>m*10^e</literal> ) is the determinant of the square matrix <literal>X</literal>.
+            <literal>det(X)</literal> ( <literal>m*10^e</literal> is the determinant of the square matrix <literal>X</literal>.
         </para>
         <para>
             For polynomial matrix <literal>det(X)</literal> is equivalent to <literal>determ(X)</literal>.
         <para>
             For rational matrices <literal>det(X)</literal> is equivalent to <literal>detr(X)</literal>.
         </para>
+        <para>
+            <important>
+                The <literal>det</literal> and <literal>detr</literal> functions don't use the same algorithm. 
+                For a rational fraction, <literal>det(X)</literal> is overloaded by <literal>%r_det(X)</literal> which is based on the <literal>determ</literal> function.
+                <literal>detr()</literal> uses the Leverrier method.
+            </important>
+            <warning>
+                Sometimes the <literal>det</literal> and <literal>detr</literal> functions may return different values for rational matrices.
+                In such cases you should set rational simplification mode off by using <code>simp_mode(%f)</code> to get the same result.
+            </warning>
+        </para>
     </refsection>
     <refsection>
         <title>References</title>
@@ -68,7 +79,7 @@
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 x=poly(0,'x');
 det([x,1+x;2-x,x^2])
 w=ssrand(2,2,4);roots(det(systmat(w))),trzeros(w)   //zeros of linear system
@@ -85,6 +96,9 @@ det(A), prod(spec(A))
             <member>
                 <link linkend="determ">determ</link>
             </member>
+            <member>
+                <link linkend="simp_mode">simp_mode</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>