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