<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - Samuel GOUGEON
 * Copyright (C) 2008 - INRIA
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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>Transposition with reference to the 2nd diagonal</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>[Y] = pertrans(X)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>X, Y</term>
                <listitem>
                    <para>square or rectangular matrices of any data type</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <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>
            with reference to the second diagonal (utility function).
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <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>
    <refsection role="see also">
        <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>
    </refsection>
</refentry>
