* Bug #6583 fixed - jmat() was poorly documented.
[scilab.git] / scilab / modules / signal_processing / help / en_US / miscellaneous / jmat.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="jmat">
3     <refnamediv>
4         <refname>jmat</refname>
5         <refpurpose>row or column block permutation</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[j]=jmat(n,m)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>n</term>
16                 <listitem>
17                     <para>number of block rows or block columns of the matrix</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>m</term>
22                 <listitem>
23                     <para>size of the (square) blocks</para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>j</term>
28                 <listitem>
29                     <para>(m*n,m*n) matrix with m*m eyed blocks</para>
30                 </listitem>
31             </varlistentry>
32         </variablelist>
33     </refsection>
34     <refsection>
35         <title>Description</title>
36         <para>
37             This function yields a square matrix <varname>j</varname> of size (m*n, m*n) that can be used for permuting the n blocks of m consecutive columns of a (m*n, m*n) square matrix W by W*j. For permuting the <varname>n</varname> blocks of <varname>m</varname> consecutive rows, use: j'*W
38         </para>
39     </refsection>
40     <refsection>
41         <title>Example</title>
42         <programlisting role="example"><![CDATA[
43 m=grand(4,4,"uin",0,9).*.ones(2,2)
44 j=jmat(4,2)
45 m*j   // permutes blocks of columns
46 j'*m  // permutes blocks of rows
47  ]]></programlisting>
48     </refsection>
49     
50 </refentry>