[Obsolete] mfft 32/15332/4
Bruno JOFRET [Tue, 7 Oct 2014 12:10:14 +0000 (14:10 +0200)]
Change-Id: I57f8da6a534b83e54f582d773c889c7fa7cf274b

scilab/CHANGES_5.5.X
scilab/modules/helptools/data/configuration/scilab_macros.txt
scilab/modules/signal_processing/help/en_US/transforms/mfft.xml [deleted file]
scilab/modules/signal_processing/help/ja_JP/transforms/mfft.xml [deleted file]
scilab/modules/signal_processing/macros/mfft.sci [deleted file]
scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.dia.ref [deleted file]
scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.tst [deleted file]

index bd4b431..d22bce2 100644 (file)
@@ -10,6 +10,9 @@ Removed Functions
 
 * %asn removed. Please use delip instead.
 
+* mfft removed. Please use fft instead.
+
+
                      Changes between version 5.5.0 and 5.5.1
                      =======================================
 
diff --git a/scilab/modules/signal_processing/help/en_US/transforms/mfft.xml b/scilab/modules/signal_processing/help/en_US/transforms/mfft.xml
deleted file mode 100644 (file)
index 39983d8..0000000
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<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="mfft">
-    <refnamediv>
-        <refname>mfft</refname>
-        <refpurpose>
-            multi-dimensional fft. <emphasis role="bold">This function is obsolete.</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Calling Sequence</title>
-        <synopsis>[xk]=mfft(x,flag,dim)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Arguments</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>
-                        <literal>x(i,j,k,...)</literal> input signal in the form of a row vector whose values are arranged so that the i index runs the quickest, followed by the j index, etc.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>flag</term>
-                <listitem>
-                    <para>(-1) FFT or (1) inverse FFT</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>dim</term>
-                <listitem>
-                    <para>
-                        dimension vector which gives the number of values of <varname>x</varname> for each of its indices.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>xk</term>
-                <listitem>
-                    <para>
-                        output of multidimensional fft in same format as for
-                        <varname>x</varname>
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Description</title>
-        <para>
-            FFT for a multi-dimensional signal
-        </para>
-        <para>
-            For example for a three dimensional vector which has three
-            points along its first dimension, two points along its second
-            dimension and three points along its third dimension the row
-            vector is arranged as follows
-        </para>
-        <programlisting role="no-scilab-exec"><![CDATA[ 
-x=[x(1,1,1),x(2,1,1),x(3,1,1),...
-   x(1,2,1),x(2,2,1),x(3,2,1),...
-   x(1,1,2),x(2,1,2),x(3,1,2),...
-   x(1,2,2),x(2,2,2),x(3,2,2),...
-   x(1,1,3),x(2,1,3),x(3,1,3),...
-   x(1,2,3),x(2,2,3),x(3,2,3)]
- ]]></programlisting>
-        <para>
-            and the <varname>dim</varname> vector is:
-            <literal>dim=[3,2,3]</literal>
-        </para>
-        <para>
-            <function>mfft</function> is superseeded by <link
-      linkend="fft">fft</link>: <literal> mfft(x,flag,dim)</literal>
-            is equivalent to
-            <literal>matrix(fft(matrix(x,dim),flag),size(x))</literal>.
-        </para>
-        <para>
-            <warning>This function is obsolete.</warning>
-            It is better to use <link linkend="fft">fft</link> instead of <function>mfft</function>
-        </para>
-    </refsection>
-    <refsection role="see also">
-        <title>See also</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="fft">fft</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection>
-        <title>History</title>
-        <revhistory>
-            <revision>
-                <revnumber>5.5.0</revnumber>
-                <revdescription>
-                    Function tagged as obsolete. Will be removed in 5.5.1. Please use <link linkend="fft">fft</link> instead.
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/signal_processing/help/ja_JP/transforms/mfft.xml b/scilab/modules/signal_processing/help/ja_JP/transforms/mfft.xml
deleted file mode 100644 (file)
index 634138a..0000000
+++ /dev/null
@@ -1,211 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<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="ja" xml:id="mfft">
-    
-    <refnamediv>
-        
-        <refname>mfft</refname>
-        
-        <refpurpose>
-            
-            多次元FFT.
-            
-            <emphasis role="bold">この関数は廃止されます.</emphasis>
-            
-        </refpurpose>
-        
-    </refnamediv>
-    
-    <refsynopsisdiv>
-        
-        <title>呼び出し手順</title>
-        
-        <synopsis>[xk]=mfft(x,flag,dim)</synopsis>
-        
-    </refsynopsisdiv>
-    
-    <refsection>
-        
-        <title>引数</title>
-        
-        <variablelist>
-            
-            <varlistentry>
-                
-                <term>x</term>
-                
-                <listitem>
-                    
-                    <para>
-                        
-                        <literal>x(i,j,k,...)</literal> 
-                        
-                        行ベクトル形式の入力信号で,
-                        
-                        その値はiインデックスが最初,次にjインデックスが続く,...
-                        
-                        といったように並べます.
-                        
-                    </para>
-                    
-                </listitem>
-                
-            </varlistentry>
-            
-            <varlistentry>
-                
-                <term>flag</term>
-                
-                <listitem>
-                    
-                    <para>(-1) FFT または (1) 逆FFT</para>
-                    
-                </listitem>
-                
-            </varlistentry>
-            
-            <varlistentry>
-                
-                <term>dim</term>
-                
-                <listitem>
-                    
-                    <para>
-                        
-                        各インデックスについて
-                        
-                        <literal>x</literal>の値の数を指定するベクトルの次元
-                        
-                    </para>
-                    
-                </listitem>
-                
-            </varlistentry>
-            
-            <varlistentry>
-                
-                <term>xk</term>
-                
-                <listitem>
-                    
-                    <para>
-                        
-                        多次元FFTの出力で,形式は<literal>x</literal>と同じ
-                        
-                    </para>
-                    
-                </listitem>
-                
-            </varlistentry>
-            
-        </variablelist>
-        
-    </refsection>
-    
-    <refsection>
-        
-        <title>説明</title>
-        
-        <para>
-            
-            多次元信号のFFT
-            
-        </para>
-        
-        <para>
-            
-            例えば,3次元ベクトルの場合は最初の次元に
-            
-            3つの点を有し,2番目の次元に2つの点,
-            
-            3番目の次元方向の3個の点,といったように
-            
-            行ベクトルは以下のように並べられます
-            
-        </para>
-        
-        <programlisting role=""><![CDATA[ 
-x=[x(1,1,1),x(2,1,1),x(3,1,1),
-   x(1,2,1),x(2,2,1),x(3,2,1),
-   x(1,1,2),x(2,1,2),x(3,1,2),
-   x(1,2,2),x(2,2,2),x(3,2,2),
-   x(1,1,3),x(2,1,3),x(3,1,3),
-   x(1,2,3),x(2,2,3),x(3,2,3)]
- ]]></programlisting>
-        
-        <para>
-            
-            <literal>dim</literal> ベクトルは次のようになります: 
-            
-            <literal>dim=[3,2,3]</literal>
-            
-        </para>
-        
-        <para>
-            
-            <function>mfft</function> は,
-            
-            <link linkend="fft">fft</link>で代替されました: 
-            
-            <literal> mfft(x,flag,dim)</literal>
-            
-            は
-            
-            <literal>matrix(fft(matrix(x,dim),flag),size(x))</literal>と等価です.
-            
-        </para>
-        
-        <para>
-            
-            <warning>この関数は廃止されます.</warning>
-            
-            <function>mfft</function>の代わりに
-            
-            <link linkend="fft">fft</link>を使用してください.
-            
-        </para>
-        
-    </refsection>
-    
-    <refsection role="see also">
-        
-        <title>参照</title>
-        
-        <simplelist type="inline">
-            
-            <member>
-                
-                <link linkend="fft">fft</link>
-                
-            </member>
-            
-        </simplelist>
-        
-    </refsection>
-    
-    <refsection>
-        
-        <title>履歴</title>
-        
-        <revhistory>
-            
-            <revision>
-                
-                <revnumber>5.5.0</revnumber>
-                
-                <revdescription>
-                    
-                    関数が廃止対象となりました. 5.5.1で削除されます. 
-                    
-                    代わりに <link linkend="fft">fft</link> を使用してください.
-                    
-                </revdescription>
-                
-            </revision>
-            
-        </revhistory>
-        
-    </refsection>
-    
-</refentry>
-
diff --git a/scilab/modules/signal_processing/macros/mfft.sci b/scilab/modules/signal_processing/macros/mfft.sci
deleted file mode 100644 (file)
index e8f9d8c..0000000
+++ /dev/null
@@ -1,41 +0,0 @@
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) INRIA - 1988 - C. Bunks
-//
-// This file must be used under the terms of the CeCILL.
-// This source file is licensed as described in the file COPYING, which
-// you should have received as part of this distribution.  The terms
-// are also available at
-// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
-
-function xk=mfft(x,flag,dim)
-    //xk=mfft(x,flag,dim)
-    //macro which calculates the fft for a multi-dimensional signal
-    // x    :x(i,j,k,...) input signal in the form of a row vector
-    //      :whose values are arranged so that the i index runs the
-    //      :quickest, followed by the j index, etc.
-    // flag :(-1) fft or (1) inverse fft
-    // dim  :dimension vector which gives the number of
-    //      :values of x for each of its indices
-    // xk   :output of multidimensional fft in same format as for x
-    //
-    //Example: For a three dimensional vector which has three points
-    //along its first dimension, two points along its second
-    //dimension and three points along its third dimension the row
-    //vector is arranged as follows
-    //
-    //      x=[x(1,1,1),x(2,1,1),x(3,1,1),...
-    //         x(1,2,1),x(2,2,1),x(3,2,1),...
-    //         x(1,1,2),x(2,1,2),x(3,1,2),...
-    //         x(1,2,2),x(2,2,2),x(3,2,2),...
-    //         x(1,1,3),x(2,1,3),x(3,1,3),...
-    //         x(1,2,3),x(2,2,3),x(3,2,3)]
-    //
-    //and the dim vector is as follows
-    //
-    //      dim=[3,2,3]
-    //
-    //!
-    warnobsolete("fft", "5.5.1");
-    xk=matrix(fft(matrix(x,dim),flag),size(x));
-
-endfunction
diff --git a/scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.dia.ref b/scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.dia.ref
deleted file mode 100644 (file)
index 47df201..0000000
+++ /dev/null
@@ -1,25 +0,0 @@
-// =============================================================================
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2012 - Scilab Enterprises - Vincent COUVERT
-//
-//  This file is distributed under the same license as the Scilab package.
-// =============================================================================
-//
-// <-- CLI SHELL MODE -->
-// <-- ENGLISH IMPOSED -->
-//
-// <-- Non-regression test for bug 11684 -->
-//
-// <-- Bugzilla URL -->
-// http://bugzilla.scilab.org/show_bug.cgi?id=11684
-//
-// <-- Short Description -->
-// mfft failed due to MKL fftw library restrictions.
-y1=matrix(1:6,2,3);
-y2=matrix(7:12,2,3);
-y=matrix([y1,y2],1,12);
-yf=mfft(y,-1,[2 3 2]);
-WARNING: Feature mfft is obsolete.
-         Please use fft instead.
-         This feature will be permanently removed in Scilab 5.5.1
-
diff --git a/scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.tst b/scilab/modules/signal_processing/tests/nonreg_tests/bug_11684.tst
deleted file mode 100644 (file)
index e477558..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-// =============================================================================
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2012 - Scilab Enterprises - Vincent COUVERT
-//
-//  This file is distributed under the same license as the Scilab package.
-// =============================================================================
-//
-// <-- CLI SHELL MODE -->
-// <-- ENGLISH IMPOSED -->
-//
-// <-- Non-regression test for bug 11684 -->
-//
-// <-- Bugzilla URL -->
-// http://bugzilla.scilab.org/show_bug.cgi?id=11684
-//
-// <-- Short Description -->
-// mfft failed due to MKL fftw library restrictions.
-
-y1=matrix(1:6,2,3);
-y2=matrix(7:12,2,3);
-y=matrix([y1,y2],1,12);
-yf=mfft(y,-1,[2 3 2]);
\ No newline at end of file