scilab/modules/elementary_functions/help/en_US/matrixmanipulation/pertrans.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   4  * Copyright (C) 2013 - Samuel GOUGEON
   5  * Copyright (C) 2008 - INRIA
   6  *
   7  * This file must be used under the terms of the CeCILL.
   8  * This source file is licensed as described in the file COPYING, which
   9  * you should have received as part of this distribution.  The terms
  10  * are also available at
  11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  12  *
  13  -->
  14 <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">
  15     <refnamediv>
  16         <refname>pertrans</refname>
  17         <refpurpose>Transposition with reference to the 2nd diagonal</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv>
  20         <title>Calling Sequence</title>
  21         <synopsis>[Y] = pertrans(X)</synopsis>
  22     </refsynopsisdiv>
  23     <refsection>
  24         <title>Arguments</title>
  25         <variablelist>
  26             <varlistentry>
  27                 <term>X, Y</term>
  28                 <listitem>
  29                     <para>square or rectangular matrices of any data type</para>
  30                 </listitem>
  31             </varlistentry>
  32         </variablelist>
  33     </refsection>
  34     <refsection>
  35         <title>Description</title>
  36         <para>
  37             <literal>Y = pertrans(X)</literal> returns the simultaneous permutation and transposition of
  38             <literal>X</literal>, i.e. the symmetric of <literal>X</literal>
  39             with reference to the second diagonal (utility function).
  40         </para>
  41     </refsection>
  42     <refsection>
  43         <title>Examples</title>
  44         <programlisting role="example"><![CDATA[
  45 // Square matrix:
  46 A = matrix(1:25, 5, 5);
  47 pertrans(A)
  48
  49 // Rectangular matrix:
  50 A = grand(5, 3, "uin", 0, 9);
  51 pertrans(A)
  52  ]]></programlisting>
  53     </refsection>
  54     <refsection role="see also">
  55         <title>See Also</title>
  56         <simplelist type="inline">
  57             <member>
  58                 <link linkend="quote">transposition</link>
  59             </member>
  60             <member>
  61                 <link linkend="flipdim">flipdim</link>
  62             </member>
  63             <member>
  64                 <link linkend="permute">permute</link>
  65             </member>
  66         </simplelist>
  67     </refsection>
  68 </refentry>