annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Dynamic-Arrays-in-C.html.svn-base @ 0:25bf17994ef1

First commit. VS2013, Codeblocks and Mac OSX configuration
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Thu, 09 Jul 2015 01:12:16 +0100
parents
children
rev   line source
d@0 1 <html lang="en">
d@0 2 <head>
d@0 3 <title>Dynamic Arrays in C - FFTW 3.2.1</title>
d@0 4 <meta http-equiv="Content-Type" content="text/html">
d@0 5 <meta name="description" content="FFTW 3.2.1">
d@0 6 <meta name="generator" content="makeinfo 4.8">
d@0 7 <link title="Top" rel="start" href="index.html#Top">
d@0 8 <link rel="up" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" title="Multi-dimensional Array Format">
d@0 9 <link rel="prev" href="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C" title="Fixed-size Arrays in C">
d@0 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">
d@0 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
d@0 12 <!--
d@0 13 This manual is for FFTW
d@0 14 (version 3.2.1, 5 February 2009).
d@0 15
d@0 16 Copyright (C) 2003 Matteo Frigo.
d@0 17
d@0 18 Copyright (C) 2003 Massachusetts Institute of Technology.
d@0 19
d@0 20 Permission is granted to make and distribute verbatim copies of
d@0 21 this manual provided the copyright notice and this permission
d@0 22 notice are preserved on all copies.
d@0 23
d@0 24 Permission is granted to copy and distribute modified versions of
d@0 25 this manual under the conditions for verbatim copying, provided
d@0 26 that the entire resulting derived work is distributed under the
d@0 27 terms of a permission notice identical to this one.
d@0 28
d@0 29 Permission is granted to copy and distribute translations of this
d@0 30 manual into another language, under the above conditions for
d@0 31 modified versions, except that this permission notice may be
d@0 32 stated in a translation approved by the Free Software Foundation.
d@0 33 -->
d@0 34 <meta http-equiv="Content-Style-Type" content="text/css">
d@0 35 <style type="text/css"><!--
d@0 36 pre.display { font-family:inherit }
d@0 37 pre.format { font-family:inherit }
d@0 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
d@0 39 pre.smallformat { font-family:inherit; font-size:smaller }
d@0 40 pre.smallexample { font-size:smaller }
d@0 41 pre.smalllisp { font-size:smaller }
d@0 42 span.sc { font-variant:small-caps }
d@0 43 span.roman { font-family:serif; font-weight:normal; }
d@0 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
d@0 45 --></style>
d@0 46 </head>
d@0 47 <body>
d@0 48 <div class="node">
d@0 49 <p>
d@0 50 <a name="Dynamic-Arrays-in-C"></a>
d@0 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>,
d@0 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>,
d@0 53 Up:&nbsp;<a rel="up" accesskey="u" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>
d@0 54 <hr>
d@0 55 </div>
d@0 56
d@0 57 <h4 class="subsection">3.2.4 Dynamic Arrays in C</h4>
d@0 58
d@0 59 <p>We recommend allocating most arrays dynamically, with
d@0 60 <code>fftw_malloc</code>. This isn't too hard to do, although it is not as
d@0 61 straightforward for multi-dimensional arrays as it is for
d@0 62 one-dimensional arrays.
d@0 63
d@0 64 <p>Creating the array is simple: using a dynamic-allocation routine like
d@0 65 <code>fftw_malloc</code>, allocate an array big enough to store N
d@0 66 <code>fftw_complex</code> values (for a complex DFT), where N is the product
d@0 67 of the sizes of the array dimensions (i.e. the total number of complex
d@0 68 values in the array). For example, here is code to allocate a
d@0 69 5&nbsp;&times;&nbsp;12&nbsp;&times;&nbsp;27 rank-3 array:
d@0 70 <a name="index-fftw_005fmalloc-118"></a>
d@0 71 <pre class="example"> fftw_complex *an_array;
d@0 72 an_array = (fftw_complex*) fftw_malloc(5*12*27 * sizeof(fftw_complex));
d@0 73 </pre>
d@0 74 <p>Accessing the array elements, however, is more tricky&mdash;you can't
d@0 75 simply use multiple applications of the `<samp><span class="samp">[]</span></samp>' operator like you
d@0 76 could for fixed-size arrays. Instead, you have to explicitly compute
d@0 77 the offset into the array using the formula given earlier for
d@0 78 row-major arrays. For example, to reference the (i,j,k)-th
d@0 79 element of the array allocated above, you would use the expression
d@0 80 <code>an_array[k + 27 * (j + 12 * i)]</code>.
d@0 81
d@0 82 <p>This pain can be alleviated somewhat by defining appropriate macros,
d@0 83 or, in C++, creating a class and overloading the `<samp><span class="samp">()</span></samp>' operator.
d@0 84 The recent C99 standard provides a way to reinterpret the dynamic
d@0 85 array as a &ldquo;variable-length&rdquo; multi-dimensional array amenable to
d@0 86 `<samp><span class="samp">[]</span></samp>', but this feature is not yet widely supported by compilers.
d@0 87 <a name="index-C99-119"></a><a name="index-C_002b_002b-120"></a>
d@0 88 <!-- =========> -->
d@0 89
d@0 90 </body></html>
d@0 91