annotate src/fftw-3.3.3/doc/html/Fixed_002dsize-Arrays-in-C.html @ 83:ae30d91d2ffe

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