annotate src/fftw-3.3.8/doc/html/Row_002dmajor-Format.html @ 82:d0c2a83c1364

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