annotate src/fftw-3.3.8/doc/html/Caveats-in-Using-Wisdom.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 d0c2a83c1364
children
rev   line source
Chris@82 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@82 2 <html>
Chris@82 3 <!-- This manual is for FFTW
Chris@82 4 (version 3.3.8, 24 May 2018).
Chris@82 5
Chris@82 6 Copyright (C) 2003 Matteo Frigo.
Chris@82 7
Chris@82 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@82 9
Chris@82 10 Permission is granted to make and distribute verbatim copies of this
Chris@82 11 manual provided the copyright notice and this permission notice are
Chris@82 12 preserved on all copies.
Chris@82 13
Chris@82 14 Permission is granted to copy and distribute modified versions of this
Chris@82 15 manual under the conditions for verbatim copying, provided that the
Chris@82 16 entire resulting derived work is distributed under the terms of a
Chris@82 17 permission notice identical to this one.
Chris@82 18
Chris@82 19 Permission is granted to copy and distribute translations of this manual
Chris@82 20 into another language, under the above conditions for modified versions,
Chris@82 21 except that this permission notice may be stated in a translation
Chris@82 22 approved by the Free Software Foundation. -->
Chris@82 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
Chris@82 24 <head>
Chris@82 25 <title>FFTW 3.3.8: Caveats in Using Wisdom</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Caveats in Using Wisdom">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Caveats in Using Wisdom">
Chris@82 29 <meta name="resource-type" content="document">
Chris@82 30 <meta name="distribution" content="global">
Chris@82 31 <meta name="Generator" content="makeinfo">
Chris@82 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@82 33 <link href="index.html#Top" rel="start" title="Top">
Chris@82 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@82 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@82 36 <link href="Other-Important-Topics.html#Other-Important-Topics" rel="up" title="Other Important Topics">
Chris@82 37 <link href="FFTW-Reference.html#FFTW-Reference" rel="next" title="FFTW Reference">
Chris@82 38 <link href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans" rel="prev" title="Words of Wisdom-Saving Plans">
Chris@82 39 <style type="text/css">
Chris@82 40 <!--
Chris@82 41 a.summary-letter {text-decoration: none}
Chris@82 42 blockquote.indentedblock {margin-right: 0em}
Chris@82 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
Chris@82 44 blockquote.smallquotation {font-size: smaller}
Chris@82 45 div.display {margin-left: 3.2em}
Chris@82 46 div.example {margin-left: 3.2em}
Chris@82 47 div.lisp {margin-left: 3.2em}
Chris@82 48 div.smalldisplay {margin-left: 3.2em}
Chris@82 49 div.smallexample {margin-left: 3.2em}
Chris@82 50 div.smalllisp {margin-left: 3.2em}
Chris@82 51 kbd {font-style: oblique}
Chris@82 52 pre.display {font-family: inherit}
Chris@82 53 pre.format {font-family: inherit}
Chris@82 54 pre.menu-comment {font-family: serif}
Chris@82 55 pre.menu-preformatted {font-family: serif}
Chris@82 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@82 57 pre.smallexample {font-size: smaller}
Chris@82 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@82 59 pre.smalllisp {font-size: smaller}
Chris@82 60 span.nolinebreak {white-space: nowrap}
Chris@82 61 span.roman {font-family: initial; font-weight: normal}
Chris@82 62 span.sansserif {font-family: sans-serif; font-weight: normal}
Chris@82 63 ul.no-bullet {list-style: none}
Chris@82 64 -->
Chris@82 65 </style>
Chris@82 66
Chris@82 67
Chris@82 68 </head>
Chris@82 69
Chris@82 70 <body lang="en">
Chris@82 71 <a name="Caveats-in-Using-Wisdom"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 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>
Chris@82 75 </div>
Chris@82 76 <hr>
Chris@82 77 <a name="Caveats-in-Using-Wisdom-1"></a>
Chris@82 78 <h3 class="section">3.4 Caveats in Using Wisdom</h3>
Chris@82 79 <a name="index-wisdom_002c-problems-with"></a>
Chris@82 80
Chris@82 81 <blockquote>
Chris@82 82 <i>
Chris@82 83 <p>For in much wisdom is much grief, and he that increaseth knowledge
Chris@82 84 increaseth sorrow.
Chris@82 85 </i>
Chris@82 86 [Ecclesiastes 1:18]
Chris@82 87 <a name="index-Ecclesiastes"></a>
Chris@82 88 </p></blockquote>
Chris@82 89
Chris@82 90 <a name="index-portability-1"></a>
Chris@82 91 <p>There are pitfalls to using wisdom, in that it can negate FFTW&rsquo;s
Chris@82 92 ability to adapt to changing hardware and other conditions. For
Chris@82 93 example, it would be perfectly possible to export wisdom from a
Chris@82 94 program running on one processor and import it into a program running
Chris@82 95 on another processor. Doing so, however, would mean that the second
Chris@82 96 program would use plans optimized for the first processor, instead of
Chris@82 97 the one it is running on.
Chris@82 98 </p>
Chris@82 99 <p>It should be safe to reuse wisdom as long as the hardware and program
Chris@82 100 binaries remain unchanged. (Actually, the optimal plan may change even
Chris@82 101 between runs of the same binary on identical hardware, due to
Chris@82 102 differences in the virtual memory environment, etcetera. Users
Chris@82 103 seriously interested in performance should worry about this problem,
Chris@82 104 too.) It is likely that, if the same wisdom is used for two
Chris@82 105 different program binaries, even running on the same machine, the
Chris@82 106 plans may be sub-optimal because of differing code alignments. It is
Chris@82 107 therefore wise to recreate wisdom every time an application is
Chris@82 108 recompiled. The more the underlying hardware and software changes
Chris@82 109 between the creation of wisdom and its use, the greater grows
Chris@82 110 the risk of sub-optimal plans.
Chris@82 111 </p>
Chris@82 112 <p>Nevertheless, if the choice is between using <code>FFTW_ESTIMATE</code> or
Chris@82 113 using possibly-suboptimal wisdom (created on the same machine, but for a
Chris@82 114 different binary), the wisdom is likely to be better. For this reason,
Chris@82 115 we provide a function to import wisdom from a standard system-wide
Chris@82 116 location (<code>/etc/fftw/wisdom</code> on Unix):
Chris@82 117 <a name="index-wisdom_002c-system_002dwide"></a>
Chris@82 118 </p>
Chris@82 119 <div class="example">
Chris@82 120 <pre class="example">int fftw_import_system_wisdom(void);
Chris@82 121 </pre></div>
Chris@82 122 <a name="index-fftw_005fimport_005fsystem_005fwisdom"></a>
Chris@82 123
Chris@82 124 <p>FFTW also provides a standalone program, <code>fftw-wisdom</code> (described
Chris@82 125 by its own <code>man</code> page on Unix) with which users can create wisdom,
Chris@82 126 e.g. for a canonical set of sizes to store in the system wisdom file.
Chris@82 127 See <a href="Wisdom-Utilities.html#Wisdom-Utilities">Wisdom Utilities</a>.
Chris@82 128 <a name="index-fftw_002dwisdom-utility"></a>
Chris@82 129 </p>
Chris@82 130 <hr>
Chris@82 131 <div class="header">
Chris@82 132 <p>
Chris@82 133 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>
Chris@82 134 </div>
Chris@82 135
Chris@82 136
Chris@82 137
Chris@82 138 </body>
Chris@82 139 </html>