|
cannam@95
|
1 <html lang="en">
|
|
cannam@95
|
2 <head>
|
|
cannam@95
|
3 <title>Real-to-Real Transforms - FFTW 3.3.3</title>
|
|
cannam@95
|
4 <meta http-equiv="Content-Type" content="text/html">
|
|
cannam@95
|
5 <meta name="description" content="FFTW 3.3.3">
|
|
cannam@95
|
6 <meta name="generator" content="makeinfo 4.13">
|
|
cannam@95
|
7 <link title="Top" rel="start" href="index.html#Top">
|
|
cannam@95
|
8 <link rel="up" href="Basic-Interface.html#Basic-Interface" title="Basic Interface">
|
|
cannam@95
|
9 <link rel="prev" href="Real_002ddata-DFT-Array-Format.html#Real_002ddata-DFT-Array-Format" title="Real-data DFT Array Format">
|
|
cannam@95
|
10 <link rel="next" href="Real_002dto_002dReal-Transform-Kinds.html#Real_002dto_002dReal-Transform-Kinds" title="Real-to-Real Transform Kinds">
|
|
cannam@95
|
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
|
|
cannam@95
|
12 <!--
|
|
cannam@95
|
13 This manual is for FFTW
|
|
cannam@95
|
14 (version 3.3.3, 25 November 2012).
|
|
cannam@95
|
15
|
|
cannam@95
|
16 Copyright (C) 2003 Matteo Frigo.
|
|
cannam@95
|
17
|
|
cannam@95
|
18 Copyright (C) 2003 Massachusetts Institute of Technology.
|
|
cannam@95
|
19
|
|
cannam@95
|
20 Permission is granted to make and distribute verbatim copies of
|
|
cannam@95
|
21 this manual provided the copyright notice and this permission
|
|
cannam@95
|
22 notice are preserved on all copies.
|
|
cannam@95
|
23
|
|
cannam@95
|
24 Permission is granted to copy and distribute modified versions of
|
|
cannam@95
|
25 this manual under the conditions for verbatim copying, provided
|
|
cannam@95
|
26 that the entire resulting derived work is distributed under the
|
|
cannam@95
|
27 terms of a permission notice identical to this one.
|
|
cannam@95
|
28
|
|
cannam@95
|
29 Permission is granted to copy and distribute translations of this
|
|
cannam@95
|
30 manual into another language, under the above conditions for
|
|
cannam@95
|
31 modified versions, except that this permission notice may be
|
|
cannam@95
|
32 stated in a translation approved by the Free Software Foundation.
|
|
cannam@95
|
33 -->
|
|
cannam@95
|
34 <meta http-equiv="Content-Style-Type" content="text/css">
|
|
cannam@95
|
35 <style type="text/css"><!--
|
|
cannam@95
|
36 pre.display { font-family:inherit }
|
|
cannam@95
|
37 pre.format { font-family:inherit }
|
|
cannam@95
|
38 pre.smalldisplay { font-family:inherit; font-size:smaller }
|
|
cannam@95
|
39 pre.smallformat { font-family:inherit; font-size:smaller }
|
|
cannam@95
|
40 pre.smallexample { font-size:smaller }
|
|
cannam@95
|
41 pre.smalllisp { font-size:smaller }
|
|
cannam@95
|
42 span.sc { font-variant:small-caps }
|
|
cannam@95
|
43 span.roman { font-family:serif; font-weight:normal; }
|
|
cannam@95
|
44 span.sansserif { font-family:sans-serif; font-weight:normal; }
|
|
cannam@95
|
45 --></style>
|
|
cannam@95
|
46 </head>
|
|
cannam@95
|
47 <body>
|
|
cannam@95
|
48 <div class="node">
|
|
cannam@95
|
49 <a name="Real-to-Real-Transforms"></a>
|
|
cannam@95
|
50 <a name="Real_002dto_002dReal-Transforms"></a>
|
|
cannam@95
|
51 <p>
|
|
cannam@95
|
52 Next: <a rel="next" accesskey="n" href="Real_002dto_002dReal-Transform-Kinds.html#Real_002dto_002dReal-Transform-Kinds">Real-to-Real Transform Kinds</a>,
|
|
cannam@95
|
53 Previous: <a rel="previous" accesskey="p" href="Real_002ddata-DFT-Array-Format.html#Real_002ddata-DFT-Array-Format">Real-data DFT Array Format</a>,
|
|
cannam@95
|
54 Up: <a rel="up" accesskey="u" href="Basic-Interface.html#Basic-Interface">Basic Interface</a>
|
|
cannam@95
|
55 <hr>
|
|
cannam@95
|
56 </div>
|
|
cannam@95
|
57
|
|
cannam@95
|
58 <h4 class="subsection">4.3.5 Real-to-Real Transforms</h4>
|
|
cannam@95
|
59
|
|
cannam@95
|
60 <p><a name="index-r2r-203"></a>
|
|
cannam@95
|
61 <pre class="example"> fftw_plan fftw_plan_r2r_1d(int n, double *in, double *out,
|
|
cannam@95
|
62 fftw_r2r_kind kind, unsigned flags);
|
|
cannam@95
|
63 fftw_plan fftw_plan_r2r_2d(int n0, int n1, double *in, double *out,
|
|
cannam@95
|
64 fftw_r2r_kind kind0, fftw_r2r_kind kind1,
|
|
cannam@95
|
65 unsigned flags);
|
|
cannam@95
|
66 fftw_plan fftw_plan_r2r_3d(int n0, int n1, int n2,
|
|
cannam@95
|
67 double *in, double *out,
|
|
cannam@95
|
68 fftw_r2r_kind kind0,
|
|
cannam@95
|
69 fftw_r2r_kind kind1,
|
|
cannam@95
|
70 fftw_r2r_kind kind2,
|
|
cannam@95
|
71 unsigned flags);
|
|
cannam@95
|
72 fftw_plan fftw_plan_r2r(int rank, const int *n, double *in, double *out,
|
|
cannam@95
|
73 const fftw_r2r_kind *kind, unsigned flags);
|
|
cannam@95
|
74 </pre>
|
|
cannam@95
|
75 <p><a name="index-fftw_005fplan_005fr2r_005f1d-204"></a><a name="index-fftw_005fplan_005fr2r_005f2d-205"></a><a name="index-fftw_005fplan_005fr2r_005f3d-206"></a><a name="index-fftw_005fplan_005fr2r-207"></a>
|
|
cannam@95
|
76 Plan a real input/output (r2r) transform of various kinds in zero or
|
|
cannam@95
|
77 more dimensions, returning an <code>fftw_plan</code> (see <a href="Using-Plans.html#Using-Plans">Using Plans</a>).
|
|
cannam@95
|
78
|
|
cannam@95
|
79 <p>Once you have created a plan for a certain transform type and
|
|
cannam@95
|
80 parameters, then creating another plan of the same type and parameters,
|
|
cannam@95
|
81 but for different arrays, is fast and shares constant data with the
|
|
cannam@95
|
82 first plan (if it still exists).
|
|
cannam@95
|
83
|
|
cannam@95
|
84 <p>The planner returns <code>NULL</code> if the plan cannot be created. A
|
|
cannam@95
|
85 non-<code>NULL</code> plan is always returned by the basic interface unless
|
|
cannam@95
|
86 you are using a customized FFTW configuration supporting a restricted
|
|
cannam@95
|
87 set of transforms, or for size-1 <code>FFTW_REDFT00</code> kinds (which are
|
|
cannam@95
|
88 not defined).
|
|
cannam@95
|
89 <a name="index-FFTW_005fREDFT00-208"></a>
|
|
cannam@95
|
90
|
|
cannam@95
|
91 <h5 class="subsubheading">Arguments</h5>
|
|
cannam@95
|
92
|
|
cannam@95
|
93 <ul>
|
|
cannam@95
|
94 <li><code>rank</code> is the dimensionality of the transform (it should be the
|
|
cannam@95
|
95 size of the arrays <code>*n</code> and <code>*kind</code>), and can be any
|
|
cannam@95
|
96 non-negative integer. The ‘<samp><span class="samp">_1d</span></samp>’, ‘<samp><span class="samp">_2d</span></samp>’, and ‘<samp><span class="samp">_3d</span></samp>’
|
|
cannam@95
|
97 planners correspond to a <code>rank</code> of <code>1</code>, <code>2</code>, and
|
|
cannam@95
|
98 <code>3</code>, respectively. A <code>rank</code> of zero is equivalent to a copy
|
|
cannam@95
|
99 of one number from input to output.
|
|
cannam@95
|
100
|
|
cannam@95
|
101 <li><code>n</code>, or <code>n0</code>/<code>n1</code>/<code>n2</code>, or <code>n[rank]</code>,
|
|
cannam@95
|
102 respectively, gives the (physical) size of the transform dimensions.
|
|
cannam@95
|
103 They can be any positive integer.
|
|
cannam@95
|
104
|
|
cannam@95
|
105 <ul>
|
|
cannam@95
|
106 <li><a name="index-row_002dmajor-209"></a>Multi-dimensional arrays are stored in row-major order with dimensions:
|
|
cannam@95
|
107 <code>n0</code> x <code>n1</code>; or <code>n0</code> x <code>n1</code> x <code>n2</code>; or
|
|
cannam@95
|
108 <code>n[0]</code> x <code>n[1]</code> x ... x <code>n[rank-1]</code>.
|
|
cannam@95
|
109 See <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>.
|
|
cannam@95
|
110 <li>FFTW is generally best at handling sizes of the form
|
|
cannam@95
|
111 2<sup>a</sup> 3<sup>b</sup> 5<sup>c</sup> 7<sup>d</sup>
|
|
cannam@95
|
112 11<sup>e</sup> 13<sup>f</sup>,where e+f is either 0 or 1, and the other exponents
|
|
cannam@95
|
113 are arbitrary. Other sizes are computed by means of a slow,
|
|
cannam@95
|
114 general-purpose algorithm (which nevertheless retains <i>O</i>(<i>n</i> log <i>n</i>) performance even for prime sizes). (It is possible to customize FFTW
|
|
cannam@95
|
115 for different array sizes; see <a href="Installation-and-Customization.html#Installation-and-Customization">Installation and Customization</a>.)
|
|
cannam@95
|
116 Transforms whose sizes are powers of 2 are especially fast.
|
|
cannam@95
|
117 <li>For a <code>REDFT00</code> or <code>RODFT00</code> transform kind in a dimension of
|
|
cannam@95
|
118 size n, it is n-1 or n+1, respectively, that
|
|
cannam@95
|
119 should be factorizable in the above form.
|
|
cannam@95
|
120 </ul>
|
|
cannam@95
|
121
|
|
cannam@95
|
122 <li><code>in</code> and <code>out</code> point to the input and output arrays of the
|
|
cannam@95
|
123 transform, which may be the same (yielding an in-place transform).
|
|
cannam@95
|
124 <a name="index-in_002dplace-210"></a>These arrays are overwritten during planning, unless
|
|
cannam@95
|
125 <code>FFTW_ESTIMATE</code> is used in the flags. (The arrays need not be
|
|
cannam@95
|
126 initialized, but they must be allocated.)
|
|
cannam@95
|
127
|
|
cannam@95
|
128 <li><code>kind</code>, or <code>kind0</code>/<code>kind1</code>/<code>kind2</code>, or
|
|
cannam@95
|
129 <code>kind[rank]</code>, is the kind of r2r transform used for the
|
|
cannam@95
|
130 corresponding dimension. The valid kind constants are described in
|
|
cannam@95
|
131 <a href="Real_002dto_002dReal-Transform-Kinds.html#Real_002dto_002dReal-Transform-Kinds">Real-to-Real Transform Kinds</a>. In a multi-dimensional transform,
|
|
cannam@95
|
132 what is computed is the separable product formed by taking each
|
|
cannam@95
|
133 transform kind along the corresponding dimension, one dimension after
|
|
cannam@95
|
134 another.
|
|
cannam@95
|
135
|
|
cannam@95
|
136 <li><a name="index-flags-211"></a><code>flags</code> is a bitwise OR (‘<samp><span class="samp">|</span></samp>’) of zero or more planner flags,
|
|
cannam@95
|
137 as defined in <a href="Planner-Flags.html#Planner-Flags">Planner Flags</a>.
|
|
cannam@95
|
138
|
|
cannam@95
|
139 </ul>
|
|
cannam@95
|
140
|
|
cannam@95
|
141 <!-- =========> -->
|
|
cannam@95
|
142 </body></html>
|
|
cannam@95
|
143
|
