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) 2008 - INRIA
   5  *
   6  * This file must be used under the terms of the CeCILL.
   7  * This source file is licensed as described in the file COPYING, which
   8  * you should have received as part of this distribution.  The terms
   9  * are also available at
  10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  11  *
  12  -->
  13 <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">
  14     <refnamediv>
  15         <refname>pertrans</refname>
  16         <refpurpose>simultaneous permutation and transposition</refpurpose>
  17     </refnamediv>
  18     <refsynopsisdiv>
  19         <title>Calling Sequence</title>
  20         <synopsis>[Y]=pertrans(X)</synopsis>
  21     </refsynopsisdiv>
  22     <refsection>
  23         <title>Arguments</title>
  24         <variablelist>
  25             <varlistentry>
  26                 <term>X</term>
  27                 <listitem>
  28                     <para>real or complex matrix</para>
  29                 </listitem>
  30             </varlistentry>
  31             <varlistentry>
  32                 <term>Y</term>
  33                 <listitem>
  34                     <para>real or complex matrix</para>
  35                 </listitem>
  36             </varlistentry>
  37         </variablelist>
  38     </refsection>
  39     <refsection>
  40         <title>Description</title>
  41         <para>
  42             <literal>Y=pertrans(X)</literal> returns the simultaneous permutation and transposition of
  43             <literal>X</literal>, i.e. the symmetric of <literal>X</literal>
  44             with reference to the second diagonal (utility function).
  45         </para>
  46     </refsection>
  47     <refsection>
  48         <title>Examples</title>
  49         <programlisting role="example"><![CDATA[
  50 A = matrix(1:25,5,5)
  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="permute">permute</link>
  59             </member>
  60         </simplelist>
  61     </refsection>
  62 </refentry>