annotate src/fftw-3.3.5/doc/html/Caveats-in-Using-Wisdom.html @ 127:7867fa7e1b6b

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: Caveats in Using Wisdom</title>
cannam@127 26
cannam@127 27 <meta name="description" content="FFTW 3.3.5: Caveats in Using Wisdom">
cannam@127 28 <meta name="keywords" content="FFTW 3.3.5: Caveats in Using Wisdom">
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="Other-Important-Topics.html#Other-Important-Topics" rel="up" title="Other Important Topics">
cannam@127 37 <link href="FFTW-Reference.html#FFTW-Reference" rel="next" title="FFTW Reference">
cannam@127 38 <link href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans" rel="prev" title="Words of Wisdom-Saving Plans">
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="Caveats-in-Using-Wisdom"></a>
cannam@127 73 <div class="header">
cannam@127 74 <p>
cannam@127 75 Previous: <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans" accesskey="p" rel="prev">Words of Wisdom-Saving Plans</a>, Up: <a href="Other-Important-Topics.html#Other-Important-Topics" accesskey="u" rel="up">Other Important Topics</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="Caveats-in-Using-Wisdom-1"></a>
cannam@127 79 <h3 class="section">3.4 Caveats in Using Wisdom</h3>
cannam@127 80 <a name="index-wisdom_002c-problems-with"></a>
cannam@127 81
cannam@127 82 <blockquote>
cannam@127 83 <i><p>For in much wisdom is much grief, and he that increaseth knowledge
cannam@127 84 increaseth sorrow.
cannam@127 85 </i>[Ecclesiastes 1:18]
cannam@127 86 <a name="index-Ecclesiastes"></a>
cannam@127 87 </p></blockquote>
cannam@127 88
cannam@127 89 <a name="index-portability-1"></a>
cannam@127 90 <p>There are pitfalls to using wisdom, in that it can negate FFTW&rsquo;s
cannam@127 91 ability to adapt to changing hardware and other conditions. For
cannam@127 92 example, it would be perfectly possible to export wisdom from a
cannam@127 93 program running on one processor and import it into a program running
cannam@127 94 on another processor. Doing so, however, would mean that the second
cannam@127 95 program would use plans optimized for the first processor, instead of
cannam@127 96 the one it is running on.
cannam@127 97 </p>
cannam@127 98 <p>It should be safe to reuse wisdom as long as the hardware and program
cannam@127 99 binaries remain unchanged. (Actually, the optimal plan may change even
cannam@127 100 between runs of the same binary on identical hardware, due to
cannam@127 101 differences in the virtual memory environment, etcetera. Users
cannam@127 102 seriously interested in performance should worry about this problem,
cannam@127 103 too.) It is likely that, if the same wisdom is used for two
cannam@127 104 different program binaries, even running on the same machine, the
cannam@127 105 plans may be sub-optimal because of differing code alignments. It is
cannam@127 106 therefore wise to recreate wisdom every time an application is
cannam@127 107 recompiled. The more the underlying hardware and software changes
cannam@127 108 between the creation of wisdom and its use, the greater grows
cannam@127 109 the risk of sub-optimal plans.
cannam@127 110 </p>
cannam@127 111 <p>Nevertheless, if the choice is between using <code>FFTW_ESTIMATE</code> or
cannam@127 112 using possibly-suboptimal wisdom (created on the same machine, but for a
cannam@127 113 different binary), the wisdom is likely to be better. For this reason,
cannam@127 114 we provide a function to import wisdom from a standard system-wide
cannam@127 115 location (<code>/etc/fftw/wisdom</code> on Unix):
cannam@127 116 <a name="index-wisdom_002c-system_002dwide"></a>
cannam@127 117 </p>
cannam@127 118 <div class="example">
cannam@127 119 <pre class="example">int fftw_import_system_wisdom(void);
cannam@127 120 </pre></div>
cannam@127 121 <a name="index-fftw_005fimport_005fsystem_005fwisdom"></a>
cannam@127 122
cannam@127 123 <p>FFTW also provides a standalone program, <code>fftw-wisdom</code> (described
cannam@127 124 by its own <code>man</code> page on Unix) with which users can create wisdom,
cannam@127 125 e.g. for a canonical set of sizes to store in the system wisdom file.
cannam@127 126 See <a href="Wisdom-Utilities.html#Wisdom-Utilities">Wisdom Utilities</a>.
cannam@127 127 <a name="index-fftw_002dwisdom-utility"></a>
cannam@127 128 </p>
cannam@127 129 <hr>
cannam@127 130 <div class="header">
cannam@127 131 <p>
cannam@127 132 Previous: <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans" accesskey="p" rel="prev">Words of Wisdom-Saving Plans</a>, Up: <a href="Other-Important-Topics.html#Other-Important-Topics" accesskey="u" rel="up">Other Important Topics</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 133 </div>
cannam@127 134
cannam@127 135
cannam@127 136
cannam@127 137 </body>
cannam@127 138 </html>