Mercurial > hg > sv-dependency-builds

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

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