comparison src/fftw-3.3.3/doc/html/Fixed_002dsize-Arrays-in-C.html @ 10:37bf6b4a2645

Add FFTW3
author Chris Cannam
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
comparison
equal deleted inserted replaced
9:c0fb53affa76 10:37bf6b4a2645
1 <html lang="en">
2 <head>
3 <title>Fixed-size Arrays in C - FFTW 3.3.3</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="FFTW 3.3.3">
6 <meta name="generator" content="makeinfo 4.13">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" title="Multi-dimensional Array Format">
9 <link rel="prev" href="Column_002dmajor-Format.html#Column_002dmajor-Format" title="Column-major Format">
10 <link rel="next" href="Dynamic-Arrays-in-C.html#Dynamic-Arrays-in-C" title="Dynamic Arrays in C">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <!--
13 This manual is for FFTW
14 (version 3.3.3, 25 November 2012).
15
16 Copyright (C) 2003 Matteo Frigo.
17
18 Copyright (C) 2003 Massachusetts Institute of Technology.
19
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission
22 notice are preserved on all copies.
23
24 Permission is granted to copy and distribute modified versions of
25 this manual under the conditions for verbatim copying, provided
26 that the entire resulting derived work is distributed under the
27 terms of a permission notice identical to this one.
28
29 Permission is granted to copy and distribute translations of this
30 manual into another language, under the above conditions for
31 modified versions, except that this permission notice may be
32 stated in a translation approved by the Free Software Foundation.
33 -->
34 <meta http-equiv="Content-Style-Type" content="text/css">
35 <style type="text/css"><!--
36 pre.display { font-family:inherit }
37 pre.format { font-family:inherit }
38 pre.smalldisplay { font-family:inherit; font-size:smaller }
39 pre.smallformat { font-family:inherit; font-size:smaller }
40 pre.smallexample { font-size:smaller }
41 pre.smalllisp { font-size:smaller }
42 span.sc { font-variant:small-caps }
43 span.roman { font-family:serif; font-weight:normal; }
44 span.sansserif { font-family:sans-serif; font-weight:normal; }
45 --></style>
46 </head>
47 <body>
48 <div class="node">
49 <a name="Fixed-size-Arrays-in-C"></a>
50 <a name="Fixed_002dsize-Arrays-in-C"></a>
51 <p>
52 Next:&nbsp;<a rel="next" accesskey="n" href="Dynamic-Arrays-in-C.html#Dynamic-Arrays-in-C">Dynamic Arrays in C</a>,
53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Column_002dmajor-Format.html#Column_002dmajor-Format">Column-major Format</a>,
54 Up:&nbsp;<a rel="up" accesskey="u" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>
55 <hr>
56 </div>
57
58 <h4 class="subsection">3.2.3 Fixed-size Arrays in C</h4>
59
60 <p><a name="index-C-multi_002ddimensional-arrays-120"></a>
61 A multi-dimensional array whose size is declared at compile time in C
62 is <em>already</em> in row-major order. You don't have to do anything
63 special to transform it. For example:
64
65 <pre class="example"> {
66 fftw_complex data[N0][N1][N2];
67 fftw_plan plan;
68 ...
69 plan = fftw_plan_dft_3d(N0, N1, N2, &amp;data[0][0][0], &amp;data[0][0][0],
70 FFTW_FORWARD, FFTW_ESTIMATE);
71 ...
72 }
73 </pre>
74 <p>This will plan a 3d in-place transform of size <code>N0 x N1 x N2</code>.
75 Notice how we took the address of the zero-th element to pass to the
76 planner (we could also have used a typecast).
77
78 <p>However, we tend to <em>discourage</em> users from declaring their
79 arrays in this way, for two reasons. First, this allocates the array
80 on the stack (&ldquo;automatic&rdquo; storage), which has a very limited size on
81 most operating systems (declaring an array with more than a few
82 thousand elements will often cause a crash). (You can get around this
83 limitation on many systems by declaring the array as
84 <code>static</code> and/or global, but that has its own drawbacks.)
85 Second, it may not optimally align the array for use with a SIMD
86 FFTW (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Instead, we recommend
87 using <code>fftw_malloc</code>, as described below.
88
89 <!-- =========> -->
90 </body></html>
91