Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Wisdom-Import.html @ 82:d0c2a83c1364

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam
date Tue, 19 Nov 2019 14:52:55 +0000
parents
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: Wisdom Import</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Wisdom Import">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Wisdom Import">
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="Wisdom.html#Wisdom" rel="up" title="Wisdom">
Chris@82 37 <link href="Forgetting-Wisdom.html#Forgetting-Wisdom" rel="next" title="Forgetting Wisdom">
Chris@82 38 <link href="Wisdom-Export.html#Wisdom-Export" rel="prev" title="Wisdom Export">
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="Wisdom-Import"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 Next: <a href="Forgetting-Wisdom.html#Forgetting-Wisdom" accesskey="n" rel="next">Forgetting Wisdom</a>, Previous: <a href="Wisdom-Export.html#Wisdom-Export" accesskey="p" rel="prev">Wisdom Export</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@82 75 </div>
Chris@82 76 <hr>
Chris@82 77 <a name="Wisdom-Import-1"></a>
Chris@82 78 <h4 class="subsection">4.7.2 Wisdom Import</h4>
Chris@82 79
Chris@82 80 <div class="example">
Chris@82 81 <pre class="example">int fftw_import_system_wisdom(void);
Chris@82 82 int fftw_import_wisdom_from_filename(const char *filename);
Chris@82 83 int fftw_import_wisdom_from_string(const char *input_string);
Chris@82 84 int fftw_import_wisdom(int (*read_char)(void *), void *data);
Chris@82 85 </pre></div>
Chris@82 86 <a name="index-fftw_005fimport_005fwisdom"></a>
Chris@82 87 <a name="index-fftw_005fimport_005fsystem_005fwisdom-1"></a>
Chris@82 88 <a name="index-fftw_005fimport_005fwisdom_005ffrom_005ffilename-1"></a>
Chris@82 89 <a name="index-fftw_005fimport_005fwisdom_005ffrom_005ffile"></a>
Chris@82 90 <a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring"></a>
Chris@82 91
Chris@82 92 <p>These functions import wisdom into a program from data stored by the
Chris@82 93 <code>fftw_export_wisdom</code> functions above. (See <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans">Words of Wisdom-Saving Plans</a>.) The imported wisdom replaces any wisdom
Chris@82 94 already accumulated by the running program.
Chris@82 95 </p>
Chris@82 96 <p><code>fftw_import_wisdom</code> imports wisdom from any input medium, as
Chris@82 97 specified by the callback function <code>read_char</code>. <code>read_char</code> is
Chris@82 98 a <code>getc</code>-like function that returns the next character in the
Chris@82 99 input; its parameter is the <code>data</code> pointer passed to
Chris@82 100 <code>fftw_import_wisdom</code>. If the end of the input data is reached
Chris@82 101 (which should never happen for valid data), <code>read_char</code> should
Chris@82 102 return <code>EOF</code> (as defined in <code>&lt;stdio.h&gt;</code>). For convenience,
Chris@82 103 the following three &ldquo;wrapper&rdquo; routines are provided:
Chris@82 104 </p>
Chris@82 105 <p><code>fftw_import_wisdom_from_filename</code> reads wisdom from a file named
Chris@82 106 <code>filename</code>. A lower-level function, which requires you to open
Chris@82 107 and close the file yourself (e.g. if you want to read wisdom from a
Chris@82 108 portion of a larger file) is <code>fftw_import_wisdom_from_file</code>. This
Chris@82 109 reads wisdom from the current position in <code>input_file</code> (which
Chris@82 110 should be open with read permission); upon exit, the file remains
Chris@82 111 open, but the position of the read pointer is unspecified.
Chris@82 112 </p>
Chris@82 113 <p><code>fftw_import_wisdom_from_string</code> reads wisdom from the
Chris@82 114 <code>NULL</code>-terminated string <code>input_string</code>.
Chris@82 115 </p>
Chris@82 116 <p><code>fftw_import_system_wisdom</code> reads wisdom from an
Chris@82 117 implementation-defined standard file (<code>/etc/fftw/wisdom</code> on Unix
Chris@82 118 and GNU systems).
Chris@82 119 <a name="index-wisdom_002c-system_002dwide-1"></a>
Chris@82 120 </p>
Chris@82 121
Chris@82 122 <p>The return value of these import routines is <code>1</code> if the wisdom was
Chris@82 123 read successfully and <code>0</code> otherwise. Note that, in all of these
Chris@82 124 functions, any data in the input stream past the end of the wisdom data
Chris@82 125 is simply ignored.
Chris@82 126 </p>
Chris@82 127 <hr>
Chris@82 128 <div class="header">
Chris@82 129 <p>
Chris@82 130 Next: <a href="Forgetting-Wisdom.html#Forgetting-Wisdom" accesskey="n" rel="next">Forgetting Wisdom</a>, Previous: <a href="Wisdom-Export.html#Wisdom-Export" accesskey="p" rel="prev">Wisdom Export</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@82 131 </div>
Chris@82 132
Chris@82 133
Chris@82 134
Chris@82 135 </body>
Chris@82 136 </html>