annotate src/fftw-3.3.5/doc/html/More-DFTs-of-Real-Data.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 2cd0e3b3e1fd
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: More DFTs of Real Data</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: More DFTs of Real Data">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: More DFTs of Real Data">
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="Tutorial.html#Tutorial" rel="up" title="Tutorial">
Chris@42 37 <link href="The-Halfcomplex_002dformat-DFT.html#The-Halfcomplex_002dformat-DFT" rel="next" title="The Halfcomplex-format DFT">
Chris@42 38 <link href="Multi_002dDimensional-DFTs-of-Real-Data.html#Multi_002dDimensional-DFTs-of-Real-Data" rel="prev" title="Multi-Dimensional DFTs of Real Data">
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="More-DFTs-of-Real-Data"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Previous: <a href="Multi_002dDimensional-DFTs-of-Real-Data.html#Multi_002dDimensional-DFTs-of-Real-Data" accesskey="p" rel="prev">Multi-Dimensional DFTs of Real Data</a>, Up: <a href="Tutorial.html#Tutorial" accesskey="u" rel="up">Tutorial</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="More-DFTs-of-Real-Data-1"></a>
Chris@42 79 <h3 class="section">2.5 More DFTs of Real Data</h3>
Chris@42 80 <table class="menu" border="0" cellspacing="0">
Chris@42 81 <tr><td align="left" valign="top">&bull; <a href="The-Halfcomplex_002dformat-DFT.html#The-Halfcomplex_002dformat-DFT" accesskey="1">The Halfcomplex-format DFT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
Chris@42 82 </td></tr>
Chris@42 83 <tr><td align="left" valign="top">&bull; <a href="Real-even_002fodd-DFTs-_0028cosine_002fsine-transforms_0029.html#Real-even_002fodd-DFTs-_0028cosine_002fsine-transforms_0029" accesskey="2">Real even/odd DFTs (cosine/sine transforms)</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
Chris@42 84 </td></tr>
Chris@42 85 <tr><td align="left" valign="top">&bull; <a href="The-Discrete-Hartley-Transform.html#The-Discrete-Hartley-Transform" accesskey="3">The Discrete Hartley Transform</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
Chris@42 86 </td></tr>
Chris@42 87 </table>
Chris@42 88
Chris@42 89 <p>FFTW supports several other transform types via a unified <em>r2r</em>
Chris@42 90 (real-to-real) interface,
Chris@42 91 <a name="index-r2r"></a>
Chris@42 92 so called because it takes a real (<code>double</code>) array and outputs a
Chris@42 93 real array of the same size. These r2r transforms currently fall into
Chris@42 94 three categories: DFTs of real input and complex-Hermitian output in
Chris@42 95 halfcomplex format, DFTs of real input with even/odd symmetry
Chris@42 96 (a.k.a. discrete cosine/sine transforms, DCTs/DSTs), and discrete
Chris@42 97 Hartley transforms (DHTs), all described in more detail by the
Chris@42 98 following sections.
Chris@42 99 </p>
Chris@42 100 <p>The r2r transforms follow the by now familiar interface of creating an
Chris@42 101 <code>fftw_plan</code>, executing it with <code>fftw_execute(plan)</code>, and
Chris@42 102 destroying it with <code>fftw_destroy_plan(plan)</code>. Furthermore, all
Chris@42 103 r2r transforms share the same planner interface:
Chris@42 104 </p>
Chris@42 105 <div class="example">
Chris@42 106 <pre class="example">fftw_plan fftw_plan_r2r_1d(int n, double *in, double *out,
Chris@42 107 fftw_r2r_kind kind, unsigned flags);
Chris@42 108 fftw_plan fftw_plan_r2r_2d(int n0, int n1, double *in, double *out,
Chris@42 109 fftw_r2r_kind kind0, fftw_r2r_kind kind1,
Chris@42 110 unsigned flags);
Chris@42 111 fftw_plan fftw_plan_r2r_3d(int n0, int n1, int n2,
Chris@42 112 double *in, double *out,
Chris@42 113 fftw_r2r_kind kind0,
Chris@42 114 fftw_r2r_kind kind1,
Chris@42 115 fftw_r2r_kind kind2,
Chris@42 116 unsigned flags);
Chris@42 117 fftw_plan fftw_plan_r2r(int rank, const int *n, double *in, double *out,
Chris@42 118 const fftw_r2r_kind *kind, unsigned flags);
Chris@42 119 </pre></div>
Chris@42 120 <a name="index-fftw_005fplan_005fr2r_005f1d"></a>
Chris@42 121 <a name="index-fftw_005fplan_005fr2r_005f2d"></a>
Chris@42 122 <a name="index-fftw_005fplan_005fr2r_005f3d"></a>
Chris@42 123 <a name="index-fftw_005fplan_005fr2r"></a>
Chris@42 124
Chris@42 125 <p>Just as for the complex DFT, these plan 1d/2d/3d/multi-dimensional
Chris@42 126 transforms for contiguous arrays in row-major order, transforming (real)
Chris@42 127 input to output of the same size, where <code>n</code> specifies the
Chris@42 128 <em>physical</em> dimensions of the arrays. All positive <code>n</code> are
Chris@42 129 supported (with the exception of <code>n=1</code> for the <code>FFTW_REDFT00</code>
Chris@42 130 kind, noted in the real-even subsection below); products of small
Chris@42 131 factors are most efficient (factorizing <code>n-1</code> and <code>n+1</code> for
Chris@42 132 <code>FFTW_REDFT00</code> and <code>FFTW_RODFT00</code> kinds, described below), but
Chris@42 133 an <i>O</i>(<i>n</i>&nbsp;log&nbsp;<i>n</i>) algorithm is used even for prime sizes.
Chris@42 134 </p>
Chris@42 135 <p>Each dimension has a <em>kind</em> parameter, of type
Chris@42 136 <code>fftw_r2r_kind</code>, specifying the kind of r2r transform to be used
Chris@42 137 for that dimension.
Chris@42 138 <a name="index-kind-_0028r2r_0029"></a>
Chris@42 139 <a name="index-fftw_005fr2r_005fkind"></a>
Chris@42 140 (In the case of <code>fftw_plan_r2r</code>, this is an array <code>kind[rank]</code>
Chris@42 141 where <code>kind[i]</code> is the transform kind for the dimension
Chris@42 142 <code>n[i]</code>.) The kind can be one of a set of predefined constants,
Chris@42 143 defined in the following subsections.
Chris@42 144 </p>
Chris@42 145 <p>In other words, FFTW computes the separable product of the specified
Chris@42 146 r2r transforms over each dimension, which can be used e.g. for partial
Chris@42 147 differential equations with mixed boundary conditions. (For some r2r
Chris@42 148 kinds, notably the halfcomplex DFT and the DHT, such a separable
Chris@42 149 product is somewhat problematic in more than one dimension, however,
Chris@42 150 as is described below.)
Chris@42 151 </p>
Chris@42 152 <p>In the current version of FFTW, all r2r transforms except for the
Chris@42 153 halfcomplex type are computed via pre- or post-processing of
Chris@42 154 halfcomplex transforms, and they are therefore not as fast as they
Chris@42 155 could be. Since most other general DCT/DST codes employ a similar
Chris@42 156 algorithm, however, FFTW&rsquo;s implementation should provide at least
Chris@42 157 competitive performance.
Chris@42 158 </p>
Chris@42 159 <hr>
Chris@42 160 <div class="header">
Chris@42 161 <p>
Chris@42 162 Previous: <a href="Multi_002dDimensional-DFTs-of-Real-Data.html#Multi_002dDimensional-DFTs-of-Real-Data" accesskey="p" rel="prev">Multi-Dimensional DFTs of Real Data</a>, Up: <a href="Tutorial.html#Tutorial" accesskey="u" rel="up">Tutorial</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 163 </div>
Chris@42 164
Chris@42 165
Chris@42 166
Chris@42 167 </body>
Chris@42 168 </html>