annotate src/fftw-3.3.3/doc/html/Fixed_002dsize-Arrays-in-C.html @ 95:89f5e221ed7b

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