annotate src/fftw-3.3.5/doc/html/Row_002dmajor-Format.html @ 42:2cd0e3b3e1fd

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