* Bug #12814 fixed - Elementary_functions doc: improvement for pertrans() 64/12364/2
Samuel Gougeon [Tue, 27 Aug 2013 14:44:27 +0000 (16:44 +0200)]
pertrans(M) works only on M indices, so any type of M is accepted.

Change-Id: I4199637c84375feccc12f17d9d1234f98c2dccf1

scilab/CHANGES_5.5.X
scilab/modules/elementary_functions/help/en_US/matrixmanipulation/pertrans.xml
scilab/modules/elementary_functions/help/fr_FR/matrixmanipulation/pertrans.xml [new file with mode: 0644]

index 6d45dfc..ce03cef 100644 (file)
@@ -557,6 +557,8 @@ Bug fixes
 
 * Bug #12813 fixed - flipdim() function extended to any type of input data.
 
+* Bug #12814 fixed - Elementary_functions: improvement of pertrans() doc.
+
 * Bug #12816 fixed - Numbers pasted in editvar were not parsed according to locale.
 
 * Bug #12823 fixed - In help generation (toolbox) links were not correctly handled.
index daf2e70..4c20b3e 100644 (file)
@@ -1,37 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Samuel GOUGEON
  * 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
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="pertrans" xml:lang="en">
     <refnamediv>
         <refname>pertrans</refname>
-        <refpurpose>simultaneous permutation and transposition</refpurpose>
+        <refpurpose>Transposition with reference to the 2nd diagonal</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[Y]=pertrans(X)</synopsis>
+        <synopsis>[Y] = pertrans(X)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>X</term>
-                <listitem>
-                    <para>real or complex matrix</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Y</term>
+                <term>X, Y</term>
                 <listitem>
-                    <para>real or complex matrix</para>
+                    <para>square or rectangular matrices of any data type</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>Y=pertrans(X)</literal> returns the simultaneous permutation and transposition of
-            <literal>X</literal>, i.e. the symmetric of <literal>X</literal> 
+            <literal>Y = pertrans(X)</literal> returns the simultaneous permutation and transposition of
+            <literal>X</literal>, i.e. the symmetric of <literal>X</literal>
             with reference to the second diagonal (utility function).
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-A = matrix(1:25,5,5)
+        <programlisting role="example"><![CDATA[
+// Square matrix:
+A = matrix(1:25, 5, 5);
+pertrans(A)
+
+// Rectangular matrix:
+A = grand(5, 3, "uin", 0, 9);
 pertrans(A)
  ]]></programlisting>
     </refsection>
@@ -55,6 +55,12 @@ pertrans(A)
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="quote">transposition</link>
+            </member>
+            <member>
+                <link linkend="flipdim">flipdim</link>
+            </member>
+            <member>
                 <link linkend="permute">permute</link>
             </member>
         </simplelist>
diff --git a/scilab/modules/elementary_functions/help/fr_FR/matrixmanipulation/pertrans.xml b/scilab/modules/elementary_functions/help/fr_FR/matrixmanipulation/pertrans.xml
new file mode 100644 (file)
index 0000000..6f588b8
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Paul Bignier
+ * 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
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="pertrans" xml:lang="fr">
+    <refnamediv>
+        <refname>pertrans</refname>
+        <refpurpose>Transposition selon la seconde diagonale</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Séquence d'appel</title>
+        <synopsis>[Y] = pertrans(X)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Paramètres</title>
+        <variablelist>
+            <varlistentry>
+                <term>X, Y</term>
+                <listitem>
+                    <para>matrices carrées ou rectangulaires de n'importe quel type</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>Y = pertrans(X)</literal> retourne les permutation et transposition simulanées de
+            <literal>X</literal>, i.e. le symétrique de <literal>X</literal>
+            selon la seconde diagonale (fonction utilitaire).
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+// Matrice carrée:
+A = matrix(1:25, 5, 5);
+pertrans(A)
+
+// Matrice rectangulaire:
+A = grand(5, 3, "uin", 0, 9);
+pertrans(A)
+ ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>Voir aussi</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="quote">transposition</link>
+            </member>
+            <member>
+                <link linkend="flipdim">flipdim</link>
+            </member>
+            <member>
+                <link linkend="permute">permute</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>