annotate src/fftw-3.3.8/doc/html/Row_002dmajor-Format.html @ 167:bd3cc4d1df30

Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
cannam@167 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@167 2 <html>
cannam@167 3 <!-- This manual is for FFTW
cannam@167 4 (version 3.3.8, 24 May 2018).
cannam@167 5
cannam@167 6 Copyright (C) 2003 Matteo Frigo.
cannam@167 7
cannam@167 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@167 9
cannam@167 10 Permission is granted to make and distribute verbatim copies of this
cannam@167 11 manual provided the copyright notice and this permission notice are
cannam@167 12 preserved on all copies.
cannam@167 13
cannam@167 14 Permission is granted to copy and distribute modified versions of this
cannam@167 15 manual under the conditions for verbatim copying, provided that the
cannam@167 16 entire resulting derived work is distributed under the terms of a
cannam@167 17 permission notice identical to this one.
cannam@167 18
cannam@167 19 Permission is granted to copy and distribute translations of this manual
cannam@167 20 into another language, under the above conditions for modified versions,
cannam@167 21 except that this permission notice may be stated in a translation
cannam@167 22 approved by the Free Software Foundation. -->
cannam@167 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
cannam@167 24 <head>
cannam@167 25 <title>FFTW 3.3.8: Row-major Format</title>
cannam@167 26
cannam@167 27 <meta name="description" content="FFTW 3.3.8: Row-major Format">
cannam@167 28 <meta name="keywords" content="FFTW 3.3.8: Row-major Format">
cannam@167 29 <meta name="resource-type" content="document">
cannam@167 30 <meta name="distribution" content="global">
cannam@167 31 <meta name="Generator" content="makeinfo">
cannam@167 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@167 33 <link href="index.html#Top" rel="start" title="Top">
cannam@167 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@167 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@167 36 <link href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" rel="up" title="Multi-dimensional Array Format">
cannam@167 37 <link href="Column_002dmajor-Format.html#Column_002dmajor-Format" rel="next" title="Column-major Format">
cannam@167 38 <link href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" rel="prev" title="Multi-dimensional Array Format">
cannam@167 39 <style type="text/css">
cannam@167 40 <!--
cannam@167 41 a.summary-letter {text-decoration: none}
cannam@167 42 blockquote.indentedblock {margin-right: 0em}
cannam@167 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
cannam@167 44 blockquote.smallquotation {font-size: smaller}
cannam@167 45 div.display {margin-left: 3.2em}
cannam@167 46 div.example {margin-left: 3.2em}
cannam@167 47 div.lisp {margin-left: 3.2em}
cannam@167 48 div.smalldisplay {margin-left: 3.2em}
cannam@167 49 div.smallexample {margin-left: 3.2em}
cannam@167 50 div.smalllisp {margin-left: 3.2em}
cannam@167 51 kbd {font-style: oblique}
cannam@167 52 pre.display {font-family: inherit}
cannam@167 53 pre.format {font-family: inherit}
cannam@167 54 pre.menu-comment {font-family: serif}
cannam@167 55 pre.menu-preformatted {font-family: serif}
cannam@167 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@167 57 pre.smallexample {font-size: smaller}
cannam@167 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@167 59 pre.smalllisp {font-size: smaller}
cannam@167 60 span.nolinebreak {white-space: nowrap}
cannam@167 61 span.roman {font-family: initial; font-weight: normal}
cannam@167 62 span.sansserif {font-family: sans-serif; font-weight: normal}
cannam@167 63 ul.no-bullet {list-style: none}
cannam@167 64 -->
cannam@167 65 </style>
cannam@167 66
cannam@167 67
cannam@167 68 </head>
cannam@167 69
cannam@167 70 <body lang="en">
cannam@167 71 <a name="Row_002dmajor-Format"></a>
cannam@167 72 <div class="header">
cannam@167 73 <p>
cannam@167 74 Next: <a href="Column_002dmajor-Format.html#Column_002dmajor-Format" accesskey="n" rel="next">Column-major Format</a>, Previous: <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" accesskey="p" rel="prev">Multi-dimensional Array Format</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@167 75 </div>
cannam@167 76 <hr>
cannam@167 77 <a name="Row_002dmajor-Format-1"></a>
cannam@167 78 <h4 class="subsection">3.2.1 Row-major Format</h4>
cannam@167 79 <a name="index-row_002dmajor"></a>
cannam@167 80
cannam@167 81 <p>The multi-dimensional arrays passed to <code>fftw_plan_dft</code> etcetera
cannam@167 82 are expected to be stored as a single contiguous block in
cannam@167 83 <em>row-major</em> order (sometimes called &ldquo;C order&rdquo;). Basically, this
cannam@167 84 means that as you step through adjacent memory locations, the first
cannam@167 85 dimension&rsquo;s index varies most slowly and the last dimension&rsquo;s index
cannam@167 86 varies most quickly.
cannam@167 87 </p>
cannam@167 88 <p>To be more explicit, let us consider an array of rank <em>d</em> whose
cannam@167 89 dimensions are n<sub>0</sub>&nbsp;&times;&nbsp;n<sub>1</sub>&nbsp;&times;&nbsp;n<sub>2</sub>&nbsp;&times;&nbsp;&hellip;&nbsp;&times;&nbsp;n<sub>d-1</sub>
cannam@167 90 . Now, we specify a location in the array by a
cannam@167 91 sequence of <em>d</em> (zero-based) indices, one for each dimension:
cannam@167 92 (i<sub>0</sub>, i<sub>1</sub>, i<sub>2</sub>,..., i<sub>d-1</sub>).
cannam@167 93 If the array is stored in row-major
cannam@167 94 order, then this element is located at the position
cannam@167 95 i<sub>d-1</sub> + n<sub>d-1</sub> * (i<sub>d-2</sub> + n<sub>d-2</sub> * (... + n<sub>1</sub> * i<sub>0</sub>)).
cannam@167 96 </p>
cannam@167 97 <p>Note that, for the ordinary complex DFT, each element of the array
cannam@167 98 must be of type <code>fftw_complex</code>; i.e. a (real, imaginary) pair of
cannam@167 99 (double-precision) numbers.
cannam@167 100 </p>
cannam@167 101 <p>In the advanced FFTW interface, the physical dimensions <em>n</em> from
cannam@167 102 which the indices are computed can be different from (larger than)
cannam@167 103 the logical dimensions of the transform to be computed, in order to
cannam@167 104 transform a subset of a larger array.
cannam@167 105 <a name="index-advanced-interface-2"></a>
cannam@167 106 Note also that, in the advanced interface, the expression above is
cannam@167 107 multiplied by a <em>stride</em> to get the actual array index&mdash;this is
cannam@167 108 useful in situations where each element of the multi-dimensional array
cannam@167 109 is actually a data structure (or another array), and you just want to
cannam@167 110 transform a single field. In the basic interface, however, the stride
cannam@167 111 is 1.
cannam@167 112 <a name="index-stride"></a>
cannam@167 113 </p>
cannam@167 114
cannam@167 115
cannam@167 116
cannam@167 117 </body>
cannam@167 118 </html>