annotate src/fftw-3.3.3/doc/html/Guru-Real_002dto_002dreal-Transforms.html @ 111:585a7be09763

FFTW
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 04 Jul 2014 10:36:59 +0100
parents 89f5e221ed7b
children
rev   line source
cannam@95 1 <html lang="en">
cannam@95 2 <head>
cannam@95 3 <title>Guru Real-to-real Transforms - 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="Guru-Interface.html#Guru-Interface" title="Guru Interface">
cannam@95 9 <link rel="prev" href="Guru-Real_002ddata-DFTs.html#Guru-Real_002ddata-DFTs" title="Guru Real-data DFTs">
cannam@95 10 <link rel="next" href="64_002dbit-Guru-Interface.html#g_t64_002dbit-Guru-Interface" title="64-bit Guru Interface">
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="Guru-Real-to-real-Transforms"></a>
cannam@95 50 <a name="Guru-Real_002dto_002dreal-Transforms"></a>
cannam@95 51 <p>
cannam@95 52 Next:&nbsp;<a rel="next" accesskey="n" href="64_002dbit-Guru-Interface.html#g_t64_002dbit-Guru-Interface">64-bit Guru Interface</a>,
cannam@95 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Guru-Real_002ddata-DFTs.html#Guru-Real_002ddata-DFTs">Guru Real-data DFTs</a>,
cannam@95 54 Up:&nbsp;<a rel="up" accesskey="u" href="Guru-Interface.html#Guru-Interface">Guru Interface</a>
cannam@95 55 <hr>
cannam@95 56 </div>
cannam@95 57
cannam@95 58 <h4 class="subsection">4.5.5 Guru Real-to-real Transforms</h4>
cannam@95 59
cannam@95 60 <pre class="example"> fftw_plan fftw_plan_guru_r2r(int rank, const fftw_iodim *dims,
cannam@95 61 int howmany_rank,
cannam@95 62 const fftw_iodim *howmany_dims,
cannam@95 63 double *in, double *out,
cannam@95 64 const fftw_r2r_kind *kind,
cannam@95 65 unsigned flags);
cannam@95 66 </pre>
cannam@95 67 <p><a name="index-fftw_005fplan_005fguru_005fr2r-258"></a>
cannam@95 68 Plan a real-to-real (r2r) multi-dimensional <code>FFTW_FORWARD</code>
cannam@95 69 transform with transform dimensions given by (<code>rank</code>, <code>dims</code>)
cannam@95 70 over a multi-dimensional vector (loop) of dimensions
cannam@95 71 (<code>howmany_rank</code>, <code>howmany_dims</code>). <code>dims</code> and
cannam@95 72 <code>howmany_dims</code> should point to <code>fftw_iodim</code> arrays of length
cannam@95 73 <code>rank</code> and <code>howmany_rank</code>, respectively.
cannam@95 74
cannam@95 75 <p>The transform kind of each dimension is given by the <code>kind</code>
cannam@95 76 parameter, which should point to an array of length <code>rank</code>. Valid
cannam@95 77 <code>fftw_r2r_kind</code> constants are given in <a href="Real_002dto_002dReal-Transform-Kinds.html#Real_002dto_002dReal-Transform-Kinds">Real-to-Real Transform Kinds</a>.
cannam@95 78
cannam@95 79 <p><code>in</code> and <code>out</code> point to the real input and output arrays; they
cannam@95 80 may be the same, indicating an in-place transform.
cannam@95 81
cannam@95 82 <p><a name="index-flags-259"></a><code>flags</code> is a bitwise OR (&lsquo;<samp><span class="samp">|</span></samp>&rsquo;) of zero or more planner flags,
cannam@95 83 as defined in <a href="Planner-Flags.html#Planner-Flags">Planner Flags</a>.
cannam@95 84
cannam@95 85 <!-- =========> -->
cannam@95 86 </body></html>
cannam@95 87