comparison src/fftw-3.3.5/doc/html/Guru-Real_002ddata-DFTs.html @ 127:7867fa7e1b6b

Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
126:4a7071416412 127:7867fa7e1b6b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <!-- This manual is for FFTW
4 (version 3.3.5, 30 July 2016).
5
6 Copyright (C) 2003 Matteo Frigo.
7
8 Copyright (C) 2003 Massachusetts Institute of Technology.
9
10 Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
13
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
18
19 Permission is granted to copy and distribute translations of this manual
20 into another language, under the above conditions for modified versions,
21 except that this permission notice may be stated in a translation
22 approved by the Free Software Foundation. -->
23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.5: Guru Real-data DFTs</title>
26
27 <meta name="description" content="FFTW 3.3.5: Guru Real-data DFTs">
28 <meta name="keywords" content="FFTW 3.3.5: Guru Real-data DFTs">
29 <meta name="resource-type" content="document">
30 <meta name="distribution" content="global">
31 <meta name="Generator" content="makeinfo">
32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
33 <link href="index.html#Top" rel="start" title="Top">
34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
36 <link href="Guru-Interface.html#Guru-Interface" rel="up" title="Guru Interface">
37 <link href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms" rel="next" title="Guru Real-to-real Transforms">
38 <link href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" rel="prev" title="Guru Complex DFTs">
39 <style type="text/css">
40 <!--
41 a.summary-letter {text-decoration: none}
42 blockquote.smallquotation {font-size: smaller}
43 div.display {margin-left: 3.2em}
44 div.example {margin-left: 3.2em}
45 div.indentedblock {margin-left: 3.2em}
46 div.lisp {margin-left: 3.2em}
47 div.smalldisplay {margin-left: 3.2em}
48 div.smallexample {margin-left: 3.2em}
49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
50 div.smalllisp {margin-left: 3.2em}
51 kbd {font-style:oblique}
52 pre.display {font-family: inherit}
53 pre.format {font-family: inherit}
54 pre.menu-comment {font-family: serif}
55 pre.menu-preformatted {font-family: serif}
56 pre.smalldisplay {font-family: inherit; font-size: smaller}
57 pre.smallexample {font-size: smaller}
58 pre.smallformat {font-family: inherit; font-size: smaller}
59 pre.smalllisp {font-size: smaller}
60 span.nocodebreak {white-space:nowrap}
61 span.nolinebreak {white-space:nowrap}
62 span.roman {font-family:serif; font-weight:normal}
63 span.sansserif {font-family:sans-serif; font-weight:normal}
64 ul.no-bullet {list-style: none}
65 -->
66 </style>
67
68
69 </head>
70
71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
72 <a name="Guru-Real_002ddata-DFTs"></a>
73 <div class="header">
74 <p>
75 Next: <a href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms" accesskey="n" rel="next">Guru Real-to-real Transforms</a>, Previous: <a href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" accesskey="p" rel="prev">Guru Complex DFTs</a>, Up: <a href="Guru-Interface.html#Guru-Interface" accesskey="u" rel="up">Guru Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
76 </div>
77 <hr>
78 <a name="Guru-Real_002ddata-DFTs-1"></a>
79 <h4 class="subsection">4.5.4 Guru Real-data DFTs</h4>
80
81 <div class="example">
82 <pre class="example">fftw_plan fftw_plan_guru_dft_r2c(
83 int rank, const fftw_iodim *dims,
84 int howmany_rank, const fftw_iodim *howmany_dims,
85 double *in, fftw_complex *out,
86 unsigned flags);
87
88 fftw_plan fftw_plan_guru_split_dft_r2c(
89 int rank, const fftw_iodim *dims,
90 int howmany_rank, const fftw_iodim *howmany_dims,
91 double *in, double *ro, double *io,
92 unsigned flags);
93
94 fftw_plan fftw_plan_guru_dft_c2r(
95 int rank, const fftw_iodim *dims,
96 int howmany_rank, const fftw_iodim *howmany_dims,
97 fftw_complex *in, double *out,
98 unsigned flags);
99
100 fftw_plan fftw_plan_guru_split_dft_c2r(
101 int rank, const fftw_iodim *dims,
102 int howmany_rank, const fftw_iodim *howmany_dims,
103 double *ri, double *ii, double *out,
104 unsigned flags);
105 </pre></div>
106 <a name="index-fftw_005fplan_005fguru_005fdft_005fr2c"></a>
107 <a name="index-fftw_005fplan_005fguru_005fsplit_005fdft_005fr2c"></a>
108 <a name="index-fftw_005fplan_005fguru_005fdft_005fc2r"></a>
109 <a name="index-fftw_005fplan_005fguru_005fsplit_005fdft_005fc2r"></a>
110
111 <p>Plan a real-input (r2c) or real-output (c2r), multi-dimensional DFT with
112 transform dimensions given by (<code>rank</code>, <code>dims</code>) over a
113 multi-dimensional vector (loop) of dimensions (<code>howmany_rank</code>,
114 <code>howmany_dims</code>). <code>dims</code> and <code>howmany_dims</code> should point
115 to <code>fftw_iodim</code> arrays of length <code>rank</code> and
116 <code>howmany_rank</code>, respectively. As for the basic and advanced
117 interfaces, an r2c transform is <code>FFTW_FORWARD</code> and a c2r transform
118 is <code>FFTW_BACKWARD</code>.
119 </p>
120 <p>The <em>last</em> dimension of <code>dims</code> is interpreted specially:
121 that dimension of the real array has size <code>dims[rank-1].n</code>, but
122 that dimension of the complex array has size <code>dims[rank-1].n/2+1</code>
123 (division rounded down). The strides, on the other hand, are taken to
124 be exactly as specified. It is up to the user to specify the strides
125 appropriately for the peculiar dimensions of the data, and we do not
126 guarantee that the planner will succeed (return non-<code>NULL</code>) for
127 any dimensions other than those described in <a href="Real_002ddata-DFT-Array-Format.html#Real_002ddata-DFT-Array-Format">Real-data DFT Array Format</a> and generalized in <a href="Advanced-Real_002ddata-DFTs.html#Advanced-Real_002ddata-DFTs">Advanced Real-data DFTs</a>. (That is,
128 for an in-place transform, each individual dimension should be able to
129 operate in place.)
130 <a name="index-in_002dplace-6"></a>
131 </p>
132
133 <p><code>in</code> and <code>out</code> point to the input and output arrays for r2c
134 and c2r transforms, respectively. For split arrays, <code>ri</code> and
135 <code>ii</code> point to the real and imaginary input arrays for a c2r
136 transform, and <code>ro</code> and <code>io</code> point to the real and imaginary
137 output arrays for an r2c transform. <code>in</code> and <code>ro</code> or
138 <code>ri</code> and <code>out</code> may be the same, indicating an in-place
139 transform. (In-place transforms where <code>in</code> and <code>io</code> or
140 <code>ii</code> and <code>out</code> are the same are not currently supported.)
141 </p>
142 <a name="index-flags-6"></a>
143 <p><code>flags</code> is a bitwise OR (&lsquo;<samp>|</samp>&rsquo;) of zero or more planner flags,
144 as defined in <a href="Planner-Flags.html#Planner-Flags">Planner Flags</a>.
145 </p>
146 <p>In-place transforms of rank greater than 1 are currently only
147 supported for interleaved arrays. For split arrays, the planner will
148 return <code>NULL</code>.
149 <a name="index-in_002dplace-7"></a>
150 </p>
151 <hr>
152 <div class="header">
153 <p>
154 Next: <a href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms" accesskey="n" rel="next">Guru Real-to-real Transforms</a>, Previous: <a href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" accesskey="p" rel="prev">Guru Complex DFTs</a>, Up: <a href="Guru-Interface.html#Guru-Interface" accesskey="u" rel="up">Guru Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
155 </div>
156
157
158
159 </body>
160 </html>