annotate src/fftw-3.3.3/doc/html/Row_002dmajor-Format.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>Row-major Format - 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="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format" title="Multi-dimensional Array Format">
cannam@95 10 <link rel="next" href="Column_002dmajor-Format.html#Column_002dmajor-Format" title="Column-major Format">
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="Row-major-Format"></a>
cannam@95 50 <a name="Row_002dmajor-Format"></a>
cannam@95 51 <p>
cannam@95 52 Next:&nbsp;<a rel="next" accesskey="n" href="Column_002dmajor-Format.html#Column_002dmajor-Format">Column-major Format</a>,
cannam@95 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array 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.1 Row-major Format</h4>
cannam@95 59
cannam@95 60 <p><a name="index-row_002dmajor-115"></a>
cannam@95 61 The multi-dimensional arrays passed to <code>fftw_plan_dft</code> etcetera
cannam@95 62 are expected to be stored as a single contiguous block in
cannam@95 63 <dfn>row-major</dfn> order (sometimes called &ldquo;C order&rdquo;). Basically, this
cannam@95 64 means that as you step through adjacent memory locations, the first
cannam@95 65 dimension's index varies most slowly and the last dimension's index
cannam@95 66 varies most quickly.
cannam@95 67
cannam@95 68 <p>To be more explicit, let us consider an array of rank d whose
cannam@95 69 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>. Now, we specify a location in the array by a
cannam@95 70 sequence of d (zero-based) indices, one for each dimension:
cannam@95 71 (i<sub>0</sub>, i<sub>1</sub>, i<sub>2</sub>,..., i<sub>d-1</sub>). If the array is stored in row-major
cannam@95 72 order, then this element is located at the position
cannam@95 73 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@95 74
cannam@95 75 <p>Note that, for the ordinary complex DFT, each element of the array
cannam@95 76 must be of type <code>fftw_complex</code>; i.e. a (real, imaginary) pair of
cannam@95 77 (double-precision) numbers.
cannam@95 78
cannam@95 79 <p>In the advanced FFTW interface, the physical dimensions n from
cannam@95 80 which the indices are computed can be different from (larger than)
cannam@95 81 the logical dimensions of the transform to be computed, in order to
cannam@95 82 transform a subset of a larger array.
cannam@95 83 <a name="index-advanced-interface-116"></a>Note also that, in the advanced interface, the expression above is
cannam@95 84 multiplied by a <dfn>stride</dfn> to get the actual array index&mdash;this is
cannam@95 85 useful in situations where each element of the multi-dimensional array
cannam@95 86 is actually a data structure (or another array), and you just want to
cannam@95 87 transform a single field. In the basic interface, however, the stride
cannam@95 88 is 1.
cannam@95 89 <a name="index-stride-117"></a>
cannam@95 90 <!-- =========> -->
cannam@95 91
cannam@95 92 </body></html>
cannam@95 93