Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.3/doc/html/Wisdom-Import.html @ 10:37bf6b4a2645

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