|
cannam@95
|
1 <html lang="en">
|
|
cannam@95
|
2 <head>
|
|
cannam@95
|
3 <title>Wisdom Export - 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.html#Wisdom" title="Wisdom">
|
|
cannam@95
|
10 <link rel="next" href="Wisdom-Import.html#Wisdom-Import" title="Wisdom Import">
|
|
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-Export"></a>
|
|
cannam@95
|
50 <p>
|
|
cannam@95
|
51 Next: <a rel="next" accesskey="n" href="Wisdom-Import.html#Wisdom-Import">Wisdom Import</a>,
|
|
cannam@95
|
52 Previous: <a rel="previous" accesskey="p" href="Wisdom.html#Wisdom">Wisdom</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.1 Wisdom Export</h4>
|
|
cannam@95
|
58
|
|
cannam@95
|
59 <pre class="example"> int fftw_export_wisdom_to_filename(const char *filename);
|
|
cannam@95
|
60 void fftw_export_wisdom_to_file(FILE *output_file);
|
|
cannam@95
|
61 char *fftw_export_wisdom_to_string(void);
|
|
cannam@95
|
62 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
|
|
cannam@95
|
63 </pre>
|
|
cannam@95
|
64 <p><a name="index-fftw_005fexport_005fwisdom-278"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-279"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffile-280"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-281"></a>
|
|
cannam@95
|
65 These functions allow you to export all currently accumulated wisdom
|
|
cannam@95
|
66 in a form from which it can be later imported and restored, even
|
|
cannam@95
|
67 during a separate run of the program. (See <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans">Words of Wisdom-Saving Plans</a>.) The current store of wisdom is not affected by calling any
|
|
cannam@95
|
68 of these routines.
|
|
cannam@95
|
69
|
|
cannam@95
|
70 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
|
|
cannam@95
|
71 medium, as specified by the callback function
|
|
cannam@95
|
72 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
|
|
cannam@95
|
73 writes the character <code>c</code> to some output; its second parameter is
|
|
cannam@95
|
74 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
|
|
cannam@95
|
75 convenience, the following three “wrapper” routines are provided:
|
|
cannam@95
|
76
|
|
cannam@95
|
77 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named
|
|
cannam@95
|
78 <code>filename</code> (which is created or overwritten), returning <code>1</code>
|
|
cannam@95
|
79 on success and <code>0</code> on failure. A lower-level function, which
|
|
cannam@95
|
80 requires you to open and close the file yourself (e.g. if you want to
|
|
cannam@95
|
81 write wisdom to a portion of a larger file) is
|
|
cannam@95
|
82 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the
|
|
cannam@95
|
83 current position in <code>output_file</code>, which should be open with
|
|
cannam@95
|
84 write permission; upon exit, the file remains open and is positioned
|
|
cannam@95
|
85 at the end of the wisdom data.
|
|
cannam@95
|
86
|
|
cannam@95
|
87 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
|
|
cannam@95
|
88 <code>NULL</code>-terminated string holding the wisdom data. This string is
|
|
cannam@95
|
89 dynamically allocated, and it is the responsibility of the caller to
|
|
cannam@95
|
90 deallocate it with <code>free</code> when it is no longer needed.
|
|
cannam@95
|
91
|
|
cannam@95
|
92 <p>All of these routines export the wisdom in the same format, which we
|
|
cannam@95
|
93 will not document here except to say that it is LISP-like ASCII text
|
|
cannam@95
|
94 that is insensitive to white space.
|
|
cannam@95
|
95
|
|
cannam@95
|
96 <!-- =========> -->
|
|
cannam@95
|
97 </body></html>
|
|
cannam@95
|
98
|
