annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Wisdom-Import.html.svn-base @ 14:636c989477e7

XML changes for Public.
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Wed, 04 May 2016 11:02:59 +0100
parents 25bf17994ef1
children
rev   line source
d@0 1 <html lang="en">
d@0 2 <head>
d@0 3 <title>Wisdom Import - FFTW 3.2.1</title>
d@0 4 <meta http-equiv="Content-Type" content="text/html">
d@0 5 <meta name="description" content="FFTW 3.2.1">
d@0 6 <meta name="generator" content="makeinfo 4.8">
d@0 7 <link title="Top" rel="start" href="index.html#Top">
d@0 8 <link rel="up" href="Wisdom.html#Wisdom" title="Wisdom">
d@0 9 <link rel="prev" href="Wisdom-Export.html#Wisdom-Export" title="Wisdom Export">
d@0 10 <link rel="next" href="Forgetting-Wisdom.html#Forgetting-Wisdom" title="Forgetting Wisdom">
d@0 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
d@0 12 <!--
d@0 13 This manual is for FFTW
d@0 14 (version 3.2.1, 5 February 2009).
d@0 15
d@0 16 Copyright (C) 2003 Matteo Frigo.
d@0 17
d@0 18 Copyright (C) 2003 Massachusetts Institute of Technology.
d@0 19
d@0 20 Permission is granted to make and distribute verbatim copies of
d@0 21 this manual provided the copyright notice and this permission
d@0 22 notice are preserved on all copies.
d@0 23
d@0 24 Permission is granted to copy and distribute modified versions of
d@0 25 this manual under the conditions for verbatim copying, provided
d@0 26 that the entire resulting derived work is distributed under the
d@0 27 terms of a permission notice identical to this one.
d@0 28
d@0 29 Permission is granted to copy and distribute translations of this
d@0 30 manual into another language, under the above conditions for
d@0 31 modified versions, except that this permission notice may be
d@0 32 stated in a translation approved by the Free Software Foundation.
d@0 33 -->
d@0 34 <meta http-equiv="Content-Style-Type" content="text/css">
d@0 35 <style type="text/css"><!--
d@0 36 pre.display { font-family:inherit }
d@0 37 pre.format { font-family:inherit }
d@0 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
d@0 39 pre.smallformat { font-family:inherit; font-size:smaller }
d@0 40 pre.smallexample { font-size:smaller }
d@0 41 pre.smalllisp { font-size:smaller }
d@0 42 span.sc { font-variant:small-caps }
d@0 43 span.roman { font-family:serif; font-weight:normal; }
d@0 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
d@0 45 --></style>
d@0 46 </head>
d@0 47 <body>
d@0 48 <div class="node">
d@0 49 <p>
d@0 50 <a name="Wisdom-Import"></a>
d@0 51 Next:&nbsp;<a rel="next" accesskey="n" href="Forgetting-Wisdom.html#Forgetting-Wisdom">Forgetting Wisdom</a>,
d@0 52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom-Export.html#Wisdom-Export">Wisdom Export</a>,
d@0 53 Up:&nbsp;<a rel="up" accesskey="u" href="Wisdom.html#Wisdom">Wisdom</a>
d@0 54 <hr>
d@0 55 </div>
d@0 56
d@0 57 <h4 class="subsection">4.7.2 Wisdom Import</h4>
d@0 58
d@0 59 <pre class="example"> int fftw_import_system_wisdom(void);
d@0 60 int fftw_import_wisdom_from_file(FILE *input_file);
d@0 61 int fftw_import_wisdom_from_string(const char *input_string);
d@0 62 int fftw_import_wisdom(int (*read_char)(void *), void *data);
d@0 63 </pre>
d@0 64 <p><a name="index-fftw_005fimport_005fwisdom-273"></a><a name="index-fftw_005fimport_005fsystem_005fwisdom-274"></a><a name="index-fftw_005fimport_005fwisdom_005ffrom_005ffile-275"></a><a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring-276"></a>
d@0 65 These functions import wisdom into a program from data stored by the
d@0 66 <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
d@0 67 already accumulated by the running program.
d@0 68
d@0 69 <p><code>fftw_import_wisdom</code> imports wisdom from any input medium, as
d@0 70 specified by the callback function <code>read_char</code>. <code>read_char</code> is
d@0 71 a <code>getc</code>-like function that returns the next character in the
d@0 72 input; its parameter is the <code>data</code> pointer passed to
d@0 73 <code>fftw_import_wisdom</code>. If the end of the input data is reached
d@0 74 (which should never happen for valid data), <code>read_char</code> should
d@0 75 return <code>EOF</code> (as defined in <code>&lt;stdio.h&gt;</code>). For convenience,
d@0 76 the following two &ldquo;wrapper&rdquo; routines are provided:
d@0 77
d@0 78 <p><code>fftw_import_wisdom_from_file</code> reads wisdom from the current
d@0 79 position in <code>input_file</code>, which should be open with read
d@0 80 permission. Upon exit, the file remains open, but the position of the
d@0 81 read pointer is unspecified.
d@0 82
d@0 83 <p><code>fftw_import_wisdom_from_string</code> reads wisdom from the
d@0 84 <code>NULL</code>-terminated string <code>input_string</code>.
d@0 85
d@0 86 <p><code>fftw_import_system_wisdom</code> reads wisdom from an
d@0 87 implementation-defined standard file (<code>/etc/fftw/wisdom</code> on Unix
d@0 88 and GNU systems).
d@0 89 <a name="index-wisdom_002c-system_002dwide-277"></a>
d@0 90 The return value of these import routines is <code>1</code> if the wisdom was
d@0 91 read successfully and <code>0</code> otherwise. Note that, in all of these
d@0 92 functions, any data in the input stream past the end of the wisdom data
d@0 93 is simply ignored.
d@0 94
d@0 95 <!-- =========> -->
d@0 96 </body></html>
d@0 97