annotate src/fftw-3.3.3/doc/html/Guru-Real_002ddata-DFTs.html @ 169:223a55898ab9 tip default

Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 89f5e221ed7b
children
rev   line source
cannam@95 1 <html lang="en">
cannam@95 2 <head>
cannam@95 3 <title>Guru Real-data DFTs - 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-Complex-DFTs.html#Guru-Complex-DFTs" title="Guru Complex DFTs">
cannam@95 10 <link rel="next" href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms" title="Guru Real-to-real Transforms">
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-data-DFTs"></a>
cannam@95 50 <a name="Guru-Real_002ddata-DFTs"></a>
cannam@95 51 <p>
cannam@95 52 Next:&nbsp;<a rel="next" accesskey="n" href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms">Guru Real-to-real Transforms</a>,
cannam@95 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Guru-Complex-DFTs.html#Guru-Complex-DFTs">Guru Complex 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.4 Guru Real-data DFTs</h4>
cannam@95 59
cannam@95 60 <pre class="example"> fftw_plan fftw_plan_guru_dft_r2c(
cannam@95 61 int rank, const fftw_iodim *dims,
cannam@95 62 int howmany_rank, const fftw_iodim *howmany_dims,
cannam@95 63 double *in, fftw_complex *out,
cannam@95 64 unsigned flags);
cannam@95 65
cannam@95 66 fftw_plan fftw_plan_guru_split_dft_r2c(
cannam@95 67 int rank, const fftw_iodim *dims,
cannam@95 68 int howmany_rank, const fftw_iodim *howmany_dims,
cannam@95 69 double *in, double *ro, double *io,
cannam@95 70 unsigned flags);
cannam@95 71
cannam@95 72 fftw_plan fftw_plan_guru_dft_c2r(
cannam@95 73 int rank, const fftw_iodim *dims,
cannam@95 74 int howmany_rank, const fftw_iodim *howmany_dims,
cannam@95 75 fftw_complex *in, double *out,
cannam@95 76 unsigned flags);
cannam@95 77
cannam@95 78 fftw_plan fftw_plan_guru_split_dft_c2r(
cannam@95 79 int rank, const fftw_iodim *dims,
cannam@95 80 int howmany_rank, const fftw_iodim *howmany_dims,
cannam@95 81 double *ri, double *ii, double *out,
cannam@95 82 unsigned flags);
cannam@95 83 </pre>
cannam@95 84 <p><a name="index-fftw_005fplan_005fguru_005fdft_005fr2c-251"></a><a name="index-fftw_005fplan_005fguru_005fsplit_005fdft_005fr2c-252"></a><a name="index-fftw_005fplan_005fguru_005fdft_005fc2r-253"></a><a name="index-fftw_005fplan_005fguru_005fsplit_005fdft_005fc2r-254"></a>
cannam@95 85 Plan a real-input (r2c) or real-output (c2r), multi-dimensional DFT with
cannam@95 86 transform dimensions given by (<code>rank</code>, <code>dims</code>) over a
cannam@95 87 multi-dimensional vector (loop) of dimensions (<code>howmany_rank</code>,
cannam@95 88 <code>howmany_dims</code>). <code>dims</code> and <code>howmany_dims</code> should point
cannam@95 89 to <code>fftw_iodim</code> arrays of length <code>rank</code> and
cannam@95 90 <code>howmany_rank</code>, respectively. As for the basic and advanced
cannam@95 91 interfaces, an r2c transform is <code>FFTW_FORWARD</code> and a c2r transform
cannam@95 92 is <code>FFTW_BACKWARD</code>.
cannam@95 93
cannam@95 94 <p>The <em>last</em> dimension of <code>dims</code> is interpreted specially:
cannam@95 95 that dimension of the real array has size <code>dims[rank-1].n</code>, but
cannam@95 96 that dimension of the complex array has size <code>dims[rank-1].n/2+1</code>
cannam@95 97 (division rounded down). The strides, on the other hand, are taken to
cannam@95 98 be exactly as specified. It is up to the user to specify the strides
cannam@95 99 appropriately for the peculiar dimensions of the data, and we do not
cannam@95 100 guarantee that the planner will succeed (return non-<code>NULL</code>) for
cannam@95 101 any dimensions other than those described in <a href="Real_002ddata-DFT-Array-Format.html#Real_002ddata-DFT-Array-Format">Real-data DFT Array Format</a> and generalized in <a href="Advanced-Real_002ddata-DFTs.html#Advanced-Real_002ddata-DFTs">Advanced Real-data DFTs</a>. (That is,
cannam@95 102 for an in-place transform, each individual dimension should be able to
cannam@95 103 operate in place.)
cannam@95 104 <a name="index-in_002dplace-255"></a>
cannam@95 105
cannam@95 106 <p><code>in</code> and <code>out</code> point to the input and output arrays for r2c
cannam@95 107 and c2r transforms, respectively. For split arrays, <code>ri</code> and
cannam@95 108 <code>ii</code> point to the real and imaginary input arrays for a c2r
cannam@95 109 transform, and <code>ro</code> and <code>io</code> point to the real and imaginary
cannam@95 110 output arrays for an r2c transform. <code>in</code> and <code>ro</code> or
cannam@95 111 <code>ri</code> and <code>out</code> may be the same, indicating an in-place
cannam@95 112 transform. (In-place transforms where <code>in</code> and <code>io</code> or
cannam@95 113 <code>ii</code> and <code>out</code> are the same are not currently supported.)
cannam@95 114
cannam@95 115 <p><a name="index-flags-256"></a><code>flags</code> is a bitwise OR (&lsquo;<samp><span class="samp">|</span></samp>&rsquo;) of zero or more planner flags,
cannam@95 116 as defined in <a href="Planner-Flags.html#Planner-Flags">Planner Flags</a>.
cannam@95 117
cannam@95 118 <p>In-place transforms of rank greater than 1 are currently only
cannam@95 119 supported for interleaved arrays. For split arrays, the planner will
cannam@95 120 return <code>NULL</code>.
cannam@95 121 <a name="index-in_002dplace-257"></a>
cannam@95 122 <!-- =========> -->
cannam@95 123
cannam@95 124 </body></html>
cannam@95 125