* Bug #6583 fixed - jmat() was poorly documented. 56/9856/2
Sylvestre Ledru [Thu, 29 Nov 2012 11:16:24 +0000 (12:16 +0100)]
Change-Id: I0c87418731da638f62e4c063b0846233e0f491d9

scilab/CHANGES_5.4.X
scilab/modules/signal_processing/help/en_US/miscellaneous/jmat.xml

index 319fbef..fbe143f 100644 (file)
@@ -89,6 +89,8 @@ Bug fixes
 * Bug #3313 fixed - In the documentation, the title of a link was using the
                     id instead of the title of the page.
 
+* Bug #6583 fixed - jmat() was poorly documented.
+
 * Bug #8213 fixed - geom3d had no examples.
 
 * Bug #8395 fixed - dft has been deprecated to fft.
index 8f6a6af..1d4209a 100644 (file)
                     <para>size of the (square) blocks</para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term>j</term>
+                <listitem>
+                    <para>(m*n,m*n) matrix with m*m eyed blocks</para>
+                </listitem>
+            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Description</title>
         <para>
-            This function permutes block rows or block columns of a matrix
+            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
         </para>
     </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example"><![CDATA[
+m=grand(4,4,"uin",0,9).*.ones(2,2)
+j=jmat(4,2)
+m*j   // permutes blocks of columns
+j'*m  // permutes blocks of rows
+ ]]></programlisting>
+    </refsection>
+    
 </refentry>