comparison src/fftw-3.3.8/doc/html/Fixed_002dsize-Arrays-in-C.html @ 167:bd3cc4d1df30

Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
comparison
equal deleted inserted replaced
166:cbd6d7e562c7 167:bd3cc4d1df30
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.8, 24 May 2018).
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 6.3, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.8: Fixed-size Arrays in C</title>
26
27 <meta name="description" content="FFTW 3.3.8: Fixed-size Arrays in C">
28 <meta name="keywords" content="FFTW 3.3.8: Fixed-size Arrays in C">
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="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" rel="up" title="Multi-dimensional Array Format">
37 <link href="Dynamic-Arrays-in-C.html#Dynamic-Arrays-in-C" rel="next" title="Dynamic Arrays in C">
38 <link href="Column_002dmajor-Format.html#Column_002dmajor-Format" rel="prev" title="Column-major Format">
39 <style type="text/css">
40 <!--
41 a.summary-letter {text-decoration: none}
42 blockquote.indentedblock {margin-right: 0em}
43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
44 blockquote.smallquotation {font-size: smaller}
45 div.display {margin-left: 3.2em}
46 div.example {margin-left: 3.2em}
47 div.lisp {margin-left: 3.2em}
48 div.smalldisplay {margin-left: 3.2em}
49 div.smallexample {margin-left: 3.2em}
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.nolinebreak {white-space: nowrap}
61 span.roman {font-family: initial; font-weight: normal}
62 span.sansserif {font-family: sans-serif; font-weight: normal}
63 ul.no-bullet {list-style: none}
64 -->
65 </style>
66
67
68 </head>
69
70 <body lang="en">
71 <a name="Fixed_002dsize-Arrays-in-C"></a>
72 <div class="header">
73 <p>
74 Next: <a href="Dynamic-Arrays-in-C.html#Dynamic-Arrays-in-C" accesskey="n" rel="next">Dynamic Arrays in C</a>, Previous: <a href="Column_002dmajor-Format.html#Column_002dmajor-Format" accesskey="p" rel="prev">Column-major Format</a>, Up: <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" accesskey="u" rel="up">Multi-dimensional Array Format</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>
75 </div>
76 <hr>
77 <a name="Fixed_002dsize-Arrays-in-C-1"></a>
78 <h4 class="subsection">3.2.3 Fixed-size Arrays in C</h4>
79 <a name="index-C-multi_002ddimensional-arrays"></a>
80
81 <p>A multi-dimensional array whose size is declared at compile time in C
82 is <em>already</em> in row-major order. You don&rsquo;t have to do anything
83 special to transform it. For example:
84 </p>
85 <div class="example">
86 <pre class="example">{
87 fftw_complex data[N0][N1][N2];
88 fftw_plan plan;
89 ...
90 plan = fftw_plan_dft_3d(N0, N1, N2, &amp;data[0][0][0], &amp;data[0][0][0],
91 FFTW_FORWARD, FFTW_ESTIMATE);
92 ...
93 }
94 </pre></div>
95
96 <p>This will plan a 3d in-place transform of size <code>N0 x N1 x N2</code>.
97 Notice how we took the address of the zero-th element to pass to the
98 planner (we could also have used a typecast).
99 </p>
100 <p>However, we tend to <em>discourage</em> users from declaring their
101 arrays in this way, for two reasons. First, this allocates the array
102 on the stack (&ldquo;automatic&rdquo; storage), which has a very limited size on
103 most operating systems (declaring an array with more than a few
104 thousand elements will often cause a crash). (You can get around this
105 limitation on many systems by declaring the array as
106 <code>static</code> and/or global, but that has its own drawbacks.)
107 Second, it may not optimally align the array for use with a SIMD
108 FFTW (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Instead, we recommend
109 using <code>fftw_malloc</code>, as described below.
110 </p>
111
112
113
114 </body>
115 </html>