Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Dynamic-Arrays-in-C.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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: Dynamic Arrays in C</title>
26
27 <meta name="description" content="FFTW 3.3.5: Dynamic Arrays in C">
28 <meta name="keywords" content="FFTW 3.3.5: Dynamic 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_002dThe-Wrong-Way.html#Dynamic-Arrays-in-C_002dThe-Wrong-Way" rel="next" title="Dynamic Arrays in C-The Wrong Way">
38 <link href="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C" rel="prev" title="Fixed-size Arrays in C">
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="Dynamic-Arrays-in-C"></a>
73 <div class="header">
74 <p>
75 Next: <a href="Dynamic-Arrays-in-C_002dThe-Wrong-Way.html#Dynamic-Arrays-in-C_002dThe-Wrong-Way" accesskey="n" rel="next">Dynamic Arrays in C-The Wrong Way</a>, Previous: <a href="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C" accesskey="p" rel="prev">Fixed-size Arrays in C</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>
76 </div>
77 <hr>
78 <a name="Dynamic-Arrays-in-C-1"></a>
79 <h4 class="subsection">3.2.4 Dynamic Arrays in C</h4>
80
81 <p>We recommend allocating most arrays dynamically, with
82 <code>fftw_malloc</code>. This isn&rsquo;t too hard to do, although it is not as
83 straightforward for multi-dimensional arrays as it is for
84 one-dimensional arrays.
85 </p>
86 <p>Creating the array is simple: using a dynamic-allocation routine like
87 <code>fftw_malloc</code>, allocate an array big enough to store N
88 <code>fftw_complex</code> values (for a complex DFT), where N is the product
89 of the sizes of the array dimensions (i.e. the total number of complex
90 values in the array). For example, here is code to allocate a
91 5&nbsp;&times;&nbsp;12&nbsp;&times;&nbsp;27 rank-3 array:
92 <a name="index-fftw_005fmalloc-2"></a>
93 </p>
94 <div class="example">
95 <pre class="example">fftw_complex *an_array;
96 an_array = (fftw_complex*) fftw_malloc(5*12*27 * sizeof(fftw_complex));
97 </pre></div>
98
99 <p>Accessing the array elements, however, is more tricky&mdash;you can&rsquo;t
100 simply use multiple applications of the &lsquo;<samp>[]</samp>&rsquo; operator like you
101 could for fixed-size arrays. Instead, you have to explicitly compute
102 the offset into the array using the formula given earlier for
103 row-major arrays. For example, to reference the <em>(i,j,k)</em>-th
104 element of the array allocated above, you would use the expression
105 <code>an_array[k + 27 * (j + 12 * i)]</code>.
106 </p>
107 <p>This pain can be alleviated somewhat by defining appropriate macros,
108 or, in C++, creating a class and overloading the &lsquo;<samp>()</samp>&rsquo; operator.
109 The recent C99 standard provides a way to reinterpret the dynamic
110 array as a &ldquo;variable-length&rdquo; multi-dimensional array amenable to
111 &lsquo;<samp>[]</samp>&rsquo;, but this feature is not yet widely supported by compilers.
112 <a name="index-C99"></a>
113 <a name="index-C_002b_002b-2"></a>
114 </p>
115
116
117
118 </body>
119 </html>