comparison src/fftw-3.3.3/doc/html/Dynamic-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>Dynamic 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="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C" title="Fixed-size Arrays in C">
10 <link rel="next" href="Dynamic-Arrays-in-C_002dThe-Wrong-Way.html#Dynamic-Arrays-in-C_002dThe-Wrong-Way" title="Dynamic Arrays in C-The Wrong Way">
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="Dynamic-Arrays-in-C"></a>
50 <p>
51 Next:&nbsp;<a rel="next" accesskey="n" href="Dynamic-Arrays-in-C_002dThe-Wrong-Way.html#Dynamic-Arrays-in-C_002dThe-Wrong-Way">Dynamic Arrays in C-The Wrong Way</a>,
52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C">Fixed-size Arrays in C</a>,
53 Up:&nbsp;<a rel="up" accesskey="u" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>
54 <hr>
55 </div>
56
57 <h4 class="subsection">3.2.4 Dynamic Arrays in C</h4>
58
59 <p>We recommend allocating most arrays dynamically, with
60 <code>fftw_malloc</code>. This isn't too hard to do, although it is not as
61 straightforward for multi-dimensional arrays as it is for
62 one-dimensional arrays.
63
64 <p>Creating the array is simple: using a dynamic-allocation routine like
65 <code>fftw_malloc</code>, allocate an array big enough to store N
66 <code>fftw_complex</code> values (for a complex DFT), where N is the product
67 of the sizes of the array dimensions (i.e. the total number of complex
68 values in the array). For example, here is code to allocate a
69 5&nbsp;&times;&nbsp;12&nbsp;&times;&nbsp;27 rank-3 array:
70 <a name="index-fftw_005fmalloc-121"></a>
71 <pre class="example"> fftw_complex *an_array;
72 an_array = (fftw_complex*) fftw_malloc(5*12*27 * sizeof(fftw_complex));
73 </pre>
74 <p>Accessing the array elements, however, is more tricky&mdash;you can't
75 simply use multiple applications of the &lsquo;<samp><span class="samp">[]</span></samp>&rsquo; operator like you
76 could for fixed-size arrays. Instead, you have to explicitly compute
77 the offset into the array using the formula given earlier for
78 row-major arrays. For example, to reference the (i,j,k)-th
79 element of the array allocated above, you would use the expression
80 <code>an_array[k + 27 * (j + 12 * i)]</code>.
81
82 <p>This pain can be alleviated somewhat by defining appropriate macros,
83 or, in C++, creating a class and overloading the &lsquo;<samp><span class="samp">()</span></samp>&rsquo; operator.
84 The recent C99 standard provides a way to reinterpret the dynamic
85 array as a &ldquo;variable-length&rdquo; multi-dimensional array amenable to
86 &lsquo;<samp><span class="samp">[]</span></samp>&rsquo;, but this feature is not yet widely supported by compilers.
87 <a name="index-C99-122"></a><a name="index-C_002b_002b-123"></a>
88 <!-- =========> -->
89
90 </body></html>
91