Mercurial > hg > sv-dependency-builds

annotate 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
rev   line source
cannam@127 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@127 2 <html>
cannam@127 3 <!-- This manual is for FFTW
cannam@127 4 (version 3.3.5, 30 July 2016).
cannam@127 5
cannam@127 6 Copyright (C) 2003 Matteo Frigo.
cannam@127 7
cannam@127 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@127 9
cannam@127 10 Permission is granted to make and distribute verbatim copies of this
cannam@127 11 manual provided the copyright notice and this permission notice are
cannam@127 12 preserved on all copies.
cannam@127 13
cannam@127 14 Permission is granted to copy and distribute modified versions of this
cannam@127 15 manual under the conditions for verbatim copying, provided that the
cannam@127 16 entire resulting derived work is distributed under the terms of a
cannam@127 17 permission notice identical to this one.
cannam@127 18
cannam@127 19 Permission is granted to copy and distribute translations of this manual
cannam@127 20 into another language, under the above conditions for modified versions,
cannam@127 21 except that this permission notice may be stated in a translation
cannam@127 22 approved by the Free Software Foundation. -->
cannam@127 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
cannam@127 24 <head>
cannam@127 25 <title>FFTW 3.3.5: Dynamic Arrays in C</title>
cannam@127 26
cannam@127 27 <meta name="description" content="FFTW 3.3.5: Dynamic Arrays in C">
cannam@127 28 <meta name="keywords" content="FFTW 3.3.5: Dynamic Arrays in C">
cannam@127 29 <meta name="resource-type" content="document">
cannam@127 30 <meta name="distribution" content="global">
cannam@127 31 <meta name="Generator" content="makeinfo">
cannam@127 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@127 33 <link href="index.html#Top" rel="start" title="Top">
cannam@127 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@127 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@127 36 <link href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" rel="up" title="Multi-dimensional Array Format">
cannam@127 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">
cannam@127 38 <link href="Fixed_002dsize-Arrays-in-C.html#Fixed_002dsize-Arrays-in-C" rel="prev" title="Fixed-size Arrays in C">
cannam@127 39 <style type="text/css">
cannam@127 40 <!--
cannam@127 41 a.summary-letter {text-decoration: none}
cannam@127 42 blockquote.smallquotation {font-size: smaller}
cannam@127 43 div.display {margin-left: 3.2em}
cannam@127 44 div.example {margin-left: 3.2em}
cannam@127 45 div.indentedblock {margin-left: 3.2em}
cannam@127 46 div.lisp {margin-left: 3.2em}
cannam@127 47 div.smalldisplay {margin-left: 3.2em}
cannam@127 48 div.smallexample {margin-left: 3.2em}
cannam@127 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
cannam@127 50 div.smalllisp {margin-left: 3.2em}
cannam@127 51 kbd {font-style:oblique}
cannam@127 52 pre.display {font-family: inherit}
cannam@127 53 pre.format {font-family: inherit}
cannam@127 54 pre.menu-comment {font-family: serif}
cannam@127 55 pre.menu-preformatted {font-family: serif}
cannam@127 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@127 57 pre.smallexample {font-size: smaller}
cannam@127 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@127 59 pre.smalllisp {font-size: smaller}
cannam@127 60 span.nocodebreak {white-space:nowrap}
cannam@127 61 span.nolinebreak {white-space:nowrap}
cannam@127 62 span.roman {font-family:serif; font-weight:normal}
cannam@127 63 span.sansserif {font-family:sans-serif; font-weight:normal}
cannam@127 64 ul.no-bullet {list-style: none}
cannam@127 65 -->
cannam@127 66 </style>
cannam@127 67
cannam@127 68
cannam@127 69 </head>
cannam@127 70
cannam@127 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
cannam@127 72 <a name="Dynamic-Arrays-in-C"></a>
cannam@127 73 <div class="header">
cannam@127 74 <p>
cannam@127 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>
cannam@127 76 </div>
cannam@127 77 <hr>
cannam@127 78 <a name="Dynamic-Arrays-in-C-1"></a>
cannam@127 79 <h4 class="subsection">3.2.4 Dynamic Arrays in C</h4>
cannam@127 80
cannam@127 81 <p>We recommend allocating most arrays dynamically, with
cannam@127 82 <code>fftw_malloc</code>. This isn&rsquo;t too hard to do, although it is not as
cannam@127 83 straightforward for multi-dimensional arrays as it is for
cannam@127 84 one-dimensional arrays.
cannam@127 85 </p>
cannam@127 86 <p>Creating the array is simple: using a dynamic-allocation routine like
cannam@127 87 <code>fftw_malloc</code>, allocate an array big enough to store N
cannam@127 88 <code>fftw_complex</code> values (for a complex DFT), where N is the product
cannam@127 89 of the sizes of the array dimensions (i.e. the total number of complex
cannam@127 90 values in the array). For example, here is code to allocate a
cannam@127 91 5&nbsp;&times;&nbsp;12&nbsp;&times;&nbsp;27 rank-3 array:
cannam@127 92 <a name="index-fftw_005fmalloc-2"></a>
cannam@127 93 </p>
cannam@127 94 <div class="example">
cannam@127 95 <pre class="example">fftw_complex *an_array;
cannam@127 96 an_array = (fftw_complex*) fftw_malloc(5*12*27 * sizeof(fftw_complex));
cannam@127 97 </pre></div>
cannam@127 98
cannam@127 99 <p>Accessing the array elements, however, is more tricky&mdash;you can&rsquo;t
cannam@127 100 simply use multiple applications of the &lsquo;<samp>[]</samp>&rsquo; operator like you
cannam@127 101 could for fixed-size arrays. Instead, you have to explicitly compute
cannam@127 102 the offset into the array using the formula given earlier for
cannam@127 103 row-major arrays. For example, to reference the <em>(i,j,k)</em>-th
cannam@127 104 element of the array allocated above, you would use the expression
cannam@127 105 <code>an_array[k + 27 * (j + 12 * i)]</code>.
cannam@127 106 </p>
cannam@127 107 <p>This pain can be alleviated somewhat by defining appropriate macros,
cannam@127 108 or, in C++, creating a class and overloading the &lsquo;<samp>()</samp>&rsquo; operator.
cannam@127 109 The recent C99 standard provides a way to reinterpret the dynamic
cannam@127 110 array as a &ldquo;variable-length&rdquo; multi-dimensional array amenable to
cannam@127 111 &lsquo;<samp>[]</samp>&rsquo;, but this feature is not yet widely supported by compilers.
cannam@127 112 <a name="index-C99"></a>
cannam@127 113 <a name="index-C_002b_002b-2"></a>
cannam@127 114 </p>
cannam@127 115
cannam@127 116
cannam@127 117
cannam@127 118 </body>
cannam@127 119 </html>