Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Using-Plans.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
rev   line source
cannam@127 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@127 2 <html>
cannam@127 3 <!-- This manual is for FFTW
cannam@127 4 (version 3.3.5, 30 July 2016).
cannam@127 5
cannam@127 6 Copyright (C) 2003 Matteo Frigo.
cannam@127 7
cannam@127 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@127 9
cannam@127 10 Permission is granted to make and distribute verbatim copies of this
cannam@127 11 manual provided the copyright notice and this permission notice are
cannam@127 12 preserved on all copies.
cannam@127 13
cannam@127 14 Permission is granted to copy and distribute modified versions of this
cannam@127 15 manual under the conditions for verbatim copying, provided that the
cannam@127 16 entire resulting derived work is distributed under the terms of a
cannam@127 17 permission notice identical to this one.
cannam@127 18
cannam@127 19 Permission is granted to copy and distribute translations of this manual
cannam@127 20 into another language, under the above conditions for modified versions,
cannam@127 21 except that this permission notice may be stated in a translation
cannam@127 22 approved by the Free Software Foundation. -->
cannam@127 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
cannam@127 24 <head>
cannam@127 25 <title>FFTW 3.3.5: Using Plans</title>
cannam@127 26
cannam@127 27 <meta name="description" content="FFTW 3.3.5: Using Plans">
cannam@127 28 <meta name="keywords" content="FFTW 3.3.5: Using Plans">
cannam@127 29 <meta name="resource-type" content="document">
cannam@127 30 <meta name="distribution" content="global">
cannam@127 31 <meta name="Generator" content="makeinfo">
cannam@127 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@127 33 <link href="index.html#Top" rel="start" title="Top">
cannam@127 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@127 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@127 36 <link href="FFTW-Reference.html#FFTW-Reference" rel="up" title="FFTW Reference">
cannam@127 37 <link href="Basic-Interface.html#Basic-Interface" rel="next" title="Basic Interface">
cannam@127 38 <link href="Memory-Allocation.html#Memory-Allocation" rel="prev" title="Memory Allocation">
cannam@127 39 <style type="text/css">
cannam@127 40 <!--
cannam@127 41 a.summary-letter {text-decoration: none}
cannam@127 42 blockquote.smallquotation {font-size: smaller}
cannam@127 43 div.display {margin-left: 3.2em}
cannam@127 44 div.example {margin-left: 3.2em}
cannam@127 45 div.indentedblock {margin-left: 3.2em}
cannam@127 46 div.lisp {margin-left: 3.2em}
cannam@127 47 div.smalldisplay {margin-left: 3.2em}
cannam@127 48 div.smallexample {margin-left: 3.2em}
cannam@127 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
cannam@127 50 div.smalllisp {margin-left: 3.2em}
cannam@127 51 kbd {font-style:oblique}
cannam@127 52 pre.display {font-family: inherit}
cannam@127 53 pre.format {font-family: inherit}
cannam@127 54 pre.menu-comment {font-family: serif}
cannam@127 55 pre.menu-preformatted {font-family: serif}
cannam@127 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@127 57 pre.smallexample {font-size: smaller}
cannam@127 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@127 59 pre.smalllisp {font-size: smaller}
cannam@127 60 span.nocodebreak {white-space:nowrap}
cannam@127 61 span.nolinebreak {white-space:nowrap}
cannam@127 62 span.roman {font-family:serif; font-weight:normal}
cannam@127 63 span.sansserif {font-family:sans-serif; font-weight:normal}
cannam@127 64 ul.no-bullet {list-style: none}
cannam@127 65 -->
cannam@127 66 </style>
cannam@127 67
cannam@127 68
cannam@127 69 </head>
cannam@127 70
cannam@127 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
cannam@127 72 <a name="Using-Plans"></a>
cannam@127 73 <div class="header">
cannam@127 74 <p>
cannam@127 75 Next: <a href="Basic-Interface.html#Basic-Interface" accesskey="n" rel="next">Basic Interface</a>, Previous: <a href="Data-Types-and-Files.html#Data-Types-and-Files" accesskey="p" rel="prev">Data Types and Files</a>, Up: <a href="FFTW-Reference.html#FFTW-Reference" accesskey="u" rel="up">FFTW Reference</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>
cannam@127 76 </div>
cannam@127 77 <hr>
cannam@127 78 <a name="Using-Plans-1"></a>
cannam@127 79 <h3 class="section">4.2 Using Plans</h3>
cannam@127 80
cannam@127 81 <p>Plans for all transform types in FFTW are stored as type
cannam@127 82 <code>fftw_plan</code> (an opaque pointer type), and are created by one of the
cannam@127 83 various planning routines described in the following sections.
cannam@127 84 <a name="index-fftw_005fplan-1"></a>
cannam@127 85 An <code>fftw_plan</code> contains all information necessary to compute the
cannam@127 86 transform, including the pointers to the input and output arrays.
cannam@127 87 </p>
cannam@127 88 <div class="example">
cannam@127 89 <pre class="example">void fftw_execute(const fftw_plan plan);
cannam@127 90 </pre></div>
cannam@127 91 <a name="index-fftw_005fexecute-1"></a>
cannam@127 92
cannam@127 93 <p>This executes the <code>plan</code>, to compute the corresponding transform on
cannam@127 94 the arrays for which it was planned (which must still exist). The plan
cannam@127 95 is not modified, and <code>fftw_execute</code> can be called as many times as
cannam@127 96 desired.
cannam@127 97 </p>
cannam@127 98 <p>To apply a given plan to a different array, you can use the new-array execute
cannam@127 99 interface. See <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>.
cannam@127 100 </p>
cannam@127 101 <p><code>fftw_execute</code> (and equivalents) is the only function in FFTW
cannam@127 102 guaranteed to be thread-safe; see <a href="Thread-safety.html#Thread-safety">Thread safety</a>.
cannam@127 103 </p>
cannam@127 104 <p>This function:
cannam@127 105 </p><div class="example">
cannam@127 106 <pre class="example">void fftw_destroy_plan(fftw_plan plan);
cannam@127 107 </pre></div>
cannam@127 108 <a name="index-fftw_005fdestroy_005fplan-1"></a>
cannam@127 109 <p>deallocates the <code>plan</code> and all its associated data.
cannam@127 110 </p>
cannam@127 111 <p>FFTW&rsquo;s planner saves some other persistent data, such as the
cannam@127 112 accumulated wisdom and a list of algorithms available in the current
cannam@127 113 configuration. If you want to deallocate all of that and reset FFTW
cannam@127 114 to the pristine state it was in when you started your program, you can
cannam@127 115 call:
cannam@127 116 </p>
cannam@127 117 <div class="example">
cannam@127 118 <pre class="example">void fftw_cleanup(void);
cannam@127 119 </pre></div>
cannam@127 120 <a name="index-fftw_005fcleanup"></a>
cannam@127 121
cannam@127 122 <p>After calling <code>fftw_cleanup</code>, all existing plans become undefined,
cannam@127 123 and you should not attempt to execute them nor to destroy them. You can
cannam@127 124 however create and execute/destroy new plans, in which case FFTW starts
cannam@127 125 accumulating wisdom information again.
cannam@127 126 </p>
cannam@127 127 <p><code>fftw_cleanup</code> does not deallocate your plans, however. To prevent
cannam@127 128 memory leaks, you must still call <code>fftw_destroy_plan</code> before
cannam@127 129 executing <code>fftw_cleanup</code>.
cannam@127 130 </p>
cannam@127 131 <p>Occasionally, it may useful to know FFTW&rsquo;s internal &ldquo;cost&rdquo; metric
cannam@127 132 that it uses to compare plans to one another; this cost is
cannam@127 133 proportional to an execution time of the plan, in undocumented units,
cannam@127 134 if the plan was created with the <code>FFTW_MEASURE</code> or other
cannam@127 135 timing-based options, or alternatively is a heuristic cost function
cannam@127 136 for <code>FFTW_ESTIMATE</code> plans. (The cost values of measured and
cannam@127 137 estimated plans are not comparable, being in different units. Also,
cannam@127 138 costs from different FFTW versions or the same version compiled
cannam@127 139 differently may not be in the same units. Plans created from wisdom
cannam@127 140 have a cost of 0 since no timing measurement is performed for them.
cannam@127 141 Finally, certain problems for which only one top-level algorithm was
cannam@127 142 possible may have required no measurements of the cost of the whole
cannam@127 143 plan, in which case <code>fftw_cost</code> will also return 0.) The cost
cannam@127 144 metric for a given plan is returned by:
cannam@127 145 </p>
cannam@127 146 <div class="example">
cannam@127 147 <pre class="example">double fftw_cost(const fftw_plan plan);
cannam@127 148 </pre></div>
cannam@127 149 <a name="index-fftw_005fcost"></a>
cannam@127 150
cannam@127 151 <p>The following two routines are provided purely for academic purposes
cannam@127 152 (that is, for entertainment).
cannam@127 153 </p>
cannam@127 154 <div class="example">
cannam@127 155 <pre class="example">void fftw_flops(const fftw_plan plan,
cannam@127 156 double *add, double *mul, double *fma);
cannam@127 157 </pre></div>
cannam@127 158 <a name="index-fftw_005fflops"></a>
cannam@127 159
cannam@127 160 <p>Given a <code>plan</code>, set <code>add</code>, <code>mul</code>, and <code>fma</code> to an
cannam@127 161 exact count of the number of floating-point additions, multiplications,
cannam@127 162 and fused multiply-add operations involved in the plan&rsquo;s execution. The
cannam@127 163 total number of floating-point operations (flops) is <code>add + mul +
cannam@127 164 2*fma</code>, or <code>add + mul + fma</code> if the hardware supports fused
cannam@127 165 multiply-add instructions (although the number of FMA operations is only
cannam@127 166 approximate because of compiler voodoo). (The number of operations
cannam@127 167 should be an integer, but we use <code>double</code> to avoid overflowing
cannam@127 168 <code>int</code> for large transforms; the arguments are of type <code>double</code>
cannam@127 169 even for single and long-double precision versions of FFTW.)
cannam@127 170 </p>
cannam@127 171 <div class="example">
cannam@127 172 <pre class="example">void fftw_fprint_plan(const fftw_plan plan, FILE *output_file);
cannam@127 173 void fftw_print_plan(const fftw_plan plan);
cannam@127 174 char *fftw_sprint_plan(const fftw_plan plan);
cannam@127 175 </pre></div>
cannam@127 176 <a name="index-fftw_005ffprint_005fplan"></a>
cannam@127 177 <a name="index-fftw_005fprint_005fplan"></a>
cannam@127 178
cannam@127 179 <p>This outputs a &ldquo;nerd-readable&rdquo; representation of the <code>plan</code> to
cannam@127 180 the given file, to <code>stdout</code>, or two a newly allocated
cannam@127 181 NUL-terminated string (which the caller is responsible for deallocating
cannam@127 182 with <code>free</code>), respectively.
cannam@127 183 </p>
cannam@127 184 <hr>
cannam@127 185 <div class="header">
cannam@127 186 <p>
cannam@127 187 Next: <a href="Basic-Interface.html#Basic-Interface" accesskey="n" rel="next">Basic Interface</a>, Previous: <a href="Data-Types-and-Files.html#Data-Types-and-Files" accesskey="p" rel="prev">Data Types and Files</a>, Up: <a href="FFTW-Reference.html#FFTW-Reference" accesskey="u" rel="up">FFTW Reference</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>
cannam@127 188 </div>
cannam@127 189
cannam@127 190
cannam@127 191
cannam@127 192 </body>
cannam@127 193 </html>