scilab/modules/elementary_functions/help/en_US/matrixmanipulation/flipdim.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 - Farid BELAHCENE
   5  * Copyright (C) 2013 - Samuel GOUGEON: restriction to decimal numbers removed. Examples added for booleans, integer-encoded numbers, text, polynomials, rationals
   6  *
   7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
   8  *
   9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
  11  * This file was originally licensed under the terms of the CeCILL v2.1,
  12  * and continues to be available under such terms.
  13  * For more information, see the COPYING file which you should have received
  14  * along with this program.
  15  *
  16  -->
  17 <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="flipdim" xml:lang="en">
  18     <refnamediv>
  19         <refname>flipdim</refname>
  20         <refpurpose>reverses the order of (blocs of) rows, columns, pages.. of a matrix or hypermatrix</refpurpose>
  21     </refnamediv>
  22     <refsynopsisdiv>
  23         <title>Syntax</title>
  24         <synopsis>y = flipdim(x, dim [,sb])</synopsis>
  25     </refsynopsisdiv>
  26     <refsection role="parameters">
  27         <title>Arguments</title>
  28         <variablelist>
  29             <varlistentry>
  30                 <term>x, y</term>
  31                 <listitem>
  32                     <para>scalars, vectors, matrices, or hypermatrices of any type, of same sizes</para>
  33                 </listitem>
  34             </varlistentry>
  35             <varlistentry>
  36                 <term>dim</term>
  37                 <listitem>
  38                     <para>a positive integer, the dimension number along which the flipping should occur</para>
  39                 </listitem>
  40             </varlistentry>
  41             <varlistentry>
  42                 <term>sb</term>
  43                 <listitem>
  44                     <para>a positive integer, the size of the blocks to permute</para>
  45                 </listitem>
  46             </varlistentry>
  47         </variablelist>
  48     </refsection>
  49     <refsection role="description">
  50         <title>Description</title>
  51         <para>
  52             Given <literal>x</literal>, a scalar/vector/matrix/hypermatrix of any type and
  53             two positive integers <literal>dim</literal> and <literal>sb</literal>,
  54             this function flips the x components by blocks of size <literal>sb</literal>
  55             along the dimension number <literal>dim</literal> of <literal>x</literal>
  56             (<literal>x</literal> and <literal>y</literal> have the same size).
  57         </para>
  58         <para>
  59             The optional parameter <literal>sb</literal> (for Size Block) allows flipping
  60             <literal>x</literal> by blocks of size <literal>sb*size(x,2)</literal>
  61             (<literal>dim=1</literal>) or <literal>size(x,1)*sb</literal> (<literal>dim=2</literal>).
  62         </para>
  63     </refsection>
  64     <refsection role="examples">
  65         <title>Examples</title>
  66         <programlisting role="example"><![CDATA[
  67 // Example 1: flip x components along the first dimension
  68 x = [1 2 3 4; 5 6 7 8]
  69 dim = 1
  70 y = flipdim(x, dim)
  71
  72 // Example 2: flip x components along the second dimension
  73 dim = 2
  74 y = flipdim(x, dim)
  75
  76 // Example 3: flip x components along the third dimension
  77 x = matrix(1:24, [3 2 4])
  78 dim = 3
  79 y = flipdim(x, dim)
  80
  81 // Example 4: the first example with complex
  82 x = [1+%i 2*%i 3 4; 5 6-%i 7 8*%pi*%i]
  83 dim = 1
  84 y = flipdim(x, dim)
  85
  86 // Integer-encoded numbers:
  87 x = int16(grand(4, 3, 2, "uin", -9, 9))
  88 y = flipdim(x, 1)
  89
  90 // Booleans:
  91 x = (grand(3, 4, "uin", -9, 9) > 0)
  92 y = flipdim(x, 2)
  93
  94 // Texts:
  95 x = matrix(strsplit("a":"x", 1:23), 4, 6);
  96 x = x+x
  97 flipdim(x, 2)
  98
  99 // Polynomials:
 100 x = inv_coeff(grand(3, 9, "uin", 0, 3), 2)
 101 flipdim(x, 1)
 102
 103 // Rationals:
 104 n = inv_coeff(grand(3, 9, "uin", 0, 3), 2);
 105 d = inv_coeff(grand(3, 9, "uin", 0, 3), 2);
 106 r = n./d
 107 flipdim(r, 2)
 108  ]]></programlisting>
 109         <para>
 110             Examples using <literal>sb</literal>:
 111         </para>
 112         <programlisting role="example"><![CDATA[
 113 X = [0 1 2 3 4 5 6 7 8 9 10 11];
 114 flipdim(X, 2, 2) // => [10 11   8 9   6 7   4 5   2 3   0 1] // Block size = 2.
 115 flipdim(X, 2, 3) // => [9 10 11   6 7 8   3 4 5   0 1 2]
 116 flipdim(X, 2, 4) // => [8 9 10 11   4 5 6 7   0 1 2 3]
 117 flipdim(X, 2, 6) // => [6 7 8 9 10 11   0 1 2 3 4 5]
 118
 119 // Error if sb does not divide the targeted dimension of x.
 120 y = flipdim(x, 2, 5); // size(X) = [1 12] and sb=5 does not divide 12.
 121  ]]></programlisting>
 122     </refsection>
 123     <refsection role="history">
 124         <title>History</title>
 125         <revhistory>
 126             <revision>
 127                 <revnumber>5.5.0</revnumber>
 128                 <revremark>
 129                     Extension from decimals to any type: booleans, integers, strings, polynomials and rationals.
 130                     New input argument <literal>sb</literal> to flip <literal>x</literal> blockwise.
 131                 </revremark>
 132             </revision>
 133         </revhistory>
 134     </refsection>
 135 </refentry>