annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Complex-Multi_002dDimensional-DFTs.html.svn-base @ 4:345acbd06029

Vectorised most things to make lifer easier. Still no debug version though. Weird.
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Fri, 10 Jul 2015 03:04:11 +0100
parents 25bf17994ef1
children
rev   line source
d@0 1 <html lang="en">
d@0 2 <head>
d@0 3 <title>Complex Multi-Dimensional DFTs - FFTW 3.2.1</title>
d@0 4 <meta http-equiv="Content-Type" content="text/html">
d@0 5 <meta name="description" content="FFTW 3.2.1">
d@0 6 <meta name="generator" content="makeinfo 4.8">
d@0 7 <link title="Top" rel="start" href="index.html#Top">
d@0 8 <link rel="up" href="Tutorial.html#Tutorial" title="Tutorial">
d@0 9 <link rel="prev" href="Complex-One_002dDimensional-DFTs.html#Complex-One_002dDimensional-DFTs" title="Complex One-Dimensional DFTs">
d@0 10 <link rel="next" href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data" title="One-Dimensional DFTs of Real Data">
d@0 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
d@0 12 <!--
d@0 13 This manual is for FFTW
d@0 14 (version 3.2.1, 5 February 2009).
d@0 15
d@0 16 Copyright (C) 2003 Matteo Frigo.
d@0 17
d@0 18 Copyright (C) 2003 Massachusetts Institute of Technology.
d@0 19
d@0 20 Permission is granted to make and distribute verbatim copies of
d@0 21 this manual provided the copyright notice and this permission
d@0 22 notice are preserved on all copies.
d@0 23
d@0 24 Permission is granted to copy and distribute modified versions of
d@0 25 this manual under the conditions for verbatim copying, provided
d@0 26 that the entire resulting derived work is distributed under the
d@0 27 terms of a permission notice identical to this one.
d@0 28
d@0 29 Permission is granted to copy and distribute translations of this
d@0 30 manual into another language, under the above conditions for
d@0 31 modified versions, except that this permission notice may be
d@0 32 stated in a translation approved by the Free Software Foundation.
d@0 33 -->
d@0 34 <meta http-equiv="Content-Style-Type" content="text/css">
d@0 35 <style type="text/css"><!--
d@0 36 pre.display { font-family:inherit }
d@0 37 pre.format { font-family:inherit }
d@0 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
d@0 39 pre.smallformat { font-family:inherit; font-size:smaller }
d@0 40 pre.smallexample { font-size:smaller }
d@0 41 pre.smalllisp { font-size:smaller }
d@0 42 span.sc { font-variant:small-caps }
d@0 43 span.roman { font-family:serif; font-weight:normal; }
d@0 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
d@0 45 --></style>
d@0 46 </head>
d@0 47 <body>
d@0 48 <div class="node">
d@0 49 <p>
d@0 50 <a name="Complex-Multi-Dimensional-DFTs"></a>
d@0 51 <a name="Complex-Multi_002dDimensional-DFTs"></a>
d@0 52 Next:&nbsp;<a rel="next" accesskey="n" href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data">One-Dimensional DFTs of Real Data</a>,
d@0 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Complex-One_002dDimensional-DFTs.html#Complex-One_002dDimensional-DFTs">Complex One-Dimensional DFTs</a>,
d@0 54 Up:&nbsp;<a rel="up" accesskey="u" href="Tutorial.html#Tutorial">Tutorial</a>
d@0 55 <hr>
d@0 56 </div>
d@0 57
d@0 58 <h3 class="section">2.2 Complex Multi-Dimensional DFTs</h3>
d@0 59
d@0 60 <p>Multi-dimensional transforms work much the same way as one-dimensional
d@0 61 transforms: you allocate arrays of <code>fftw_complex</code> (preferably
d@0 62 using <code>fftw_malloc</code>), create an <code>fftw_plan</code>, execute it as
d@0 63 many times as you want with <code>fftw_execute(plan)</code>, and clean up
d@0 64 with <code>fftw_destroy_plan(plan)</code> (and <code>fftw_free</code>). The only
d@0 65 difference is the routine you use to create the plan:
d@0 66
d@0 67 <pre class="example"> fftw_plan fftw_plan_dft_2d(int n0, int n1,
d@0 68 fftw_complex *in, fftw_complex *out,
d@0 69 int sign, unsigned flags);
d@0 70 fftw_plan fftw_plan_dft_3d(int n0, int n1, int n2,
d@0 71 fftw_complex *in, fftw_complex *out,
d@0 72 int sign, unsigned flags);
d@0 73 fftw_plan fftw_plan_dft(int rank, const int *n,
d@0 74 fftw_complex *in, fftw_complex *out,
d@0 75 int sign, unsigned flags);
d@0 76 </pre>
d@0 77 <p><a name="index-fftw_005fplan_005fdft_005f2d-38"></a><a name="index-fftw_005fplan_005fdft_005f3d-39"></a><a name="index-fftw_005fplan_005fdft-40"></a>
d@0 78 These routines create plans for <code>n0</code> by <code>n1</code> two-dimensional
d@0 79 (2d) transforms, <code>n0</code> by <code>n1</code> by <code>n2</code> 3d transforms,
d@0 80 and arbitrary <code>rank</code>-dimensional transforms, respectively. In the
d@0 81 <a name="index-rank-41"></a>third case, <code>n</code> is a pointer to an array <code>n[rank]</code> denoting
d@0 82 an <code>n[0]</code> by <code>n[1]</code> by <small class="dots">...</small> by <code>n[rank-1]</code>
d@0 83 transform. All of these transforms operate on contiguous arrays in
d@0 84 the C-standard <dfn>row-major</dfn> order, so that the last dimension has
d@0 85 the fastest-varying index in the array. This layout is described
d@0 86 further in <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>.
d@0 87
d@0 88 <p>You may have noticed that all the planner routines described so far
d@0 89 have overlapping functionality. For example, you can plan a 1d or 2d
d@0 90 transform by using <code>fftw_plan_dft</code> with a <code>rank</code> of <code>1</code>
d@0 91 or <code>2</code>, or even by calling <code>fftw_plan_dft_3d</code> with <code>n0</code>
d@0 92 and/or <code>n1</code> equal to <code>1</code> (with no loss in efficiency). This
d@0 93 pattern continues, and FFTW's planning routines in general form a
d@0 94 &ldquo;partial order,&rdquo; sequences of
d@0 95 <a name="index-partial-order-42"></a>interfaces with strictly increasing generality but correspondingly
d@0 96 greater complexity.
d@0 97
d@0 98 <p><code>fftw_plan_dft</code> is the most general complex-DFT routine that we
d@0 99 describe in this tutorial, but there are also the advanced and guru interfaces,
d@0 100 <a name="index-advanced-interface-43"></a><a name="index-guru-interface-44"></a>which allow one to efficiently combine multiple/strided transforms
d@0 101 into a single FFTW plan, transform a subset of a larger
d@0 102 multi-dimensional array, and/or to handle more general complex-number
d@0 103 formats. For more information, see <a href="FFTW-Reference.html#FFTW-Reference">FFTW Reference</a>.
d@0 104
d@0 105 <!-- -->
d@0 106 </body></html>
d@0 107