annotate src/fftw-3.3.5/doc/html/Wisdom-Utilities.html @ 42:2cd0e3b3e1fd

Current fftw source
author Chris Cannam
date Tue, 18 Oct 2016 13:40:26 +0100
parents
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: Wisdom Utilities</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: Wisdom Utilities">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: Wisdom Utilities">
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="Wisdom.html#Wisdom" rel="up" title="Wisdom">
Chris@42 37 <link href="What-FFTW-Really-Computes.html#What-FFTW-Really-Computes" rel="next" title="What FFTW Really Computes">
Chris@42 38 <link href="Forgetting-Wisdom.html#Forgetting-Wisdom" rel="prev" title="Forgetting Wisdom">
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="Wisdom-Utilities"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Previous: <a href="Forgetting-Wisdom.html#Forgetting-Wisdom" accesskey="p" rel="prev">Forgetting Wisdom</a>, Up: <a href="Wisdom.html#Wisdom" accesskey="u" rel="up">Wisdom</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="Wisdom-Utilities-1"></a>
Chris@42 79 <h4 class="subsection">4.7.4 Wisdom Utilities</h4>
Chris@42 80
Chris@42 81 <p>FFTW includes two standalone utility programs that deal with wisdom. We
Chris@42 82 merely summarize them here, since they come with their own <code>man</code>
Chris@42 83 pages for Unix and GNU systems (with HTML versions on our web site).
Chris@42 84 </p>
Chris@42 85 <p>The first program is <code>fftw-wisdom</code> (or <code>fftwf-wisdom</code> in
Chris@42 86 single precision, etcetera), which can be used to create a wisdom file
Chris@42 87 containing plans for any of the transform sizes and types supported by
Chris@42 88 FFTW. It is preferable to create wisdom directly from your executable
Chris@42 89 (see <a href="Caveats-in-Using-Wisdom.html#Caveats-in-Using-Wisdom">Caveats in Using Wisdom</a>), but this program is useful for
Chris@42 90 creating global wisdom files for <code>fftw_import_system_wisdom</code>.
Chris@42 91 <a name="index-fftw_002dwisdom-utility-1"></a>
Chris@42 92 </p>
Chris@42 93
Chris@42 94 <p>The second program is <code>fftw-wisdom-to-conf</code>, which takes a wisdom
Chris@42 95 file as input and produces a <em>configuration routine</em> as output. The
Chris@42 96 latter is a C subroutine that you can compile and link into your
Chris@42 97 program, replacing a routine of the same name in the FFTW library, that
Chris@42 98 determines which parts of FFTW are callable by your program.
Chris@42 99 <code>fftw-wisdom-to-conf</code> produces a configuration routine that links
Chris@42 100 to only those parts of FFTW needed by the saved plans in the wisdom,
Chris@42 101 greatly reducing the size of statically linked executables (which should
Chris@42 102 only attempt to create plans corresponding to those in the wisdom,
Chris@42 103 however).
Chris@42 104 <a name="index-fftw_002dwisdom_002dto_002dconf-utility"></a>
Chris@42 105 <a name="index-configuration-routines"></a>
Chris@42 106 </p>
Chris@42 107
Chris@42 108
Chris@42 109
Chris@42 110 </body>
Chris@42 111 </html>