|
Chris@82
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
Chris@82
|
2 <html>
|
|
Chris@82
|
3 <!-- This manual is for FFTW
|
|
Chris@82
|
4 (version 3.3.8, 24 May 2018).
|
|
Chris@82
|
5
|
|
Chris@82
|
6 Copyright (C) 2003 Matteo Frigo.
|
|
Chris@82
|
7
|
|
Chris@82
|
8 Copyright (C) 2003 Massachusetts Institute of Technology.
|
|
Chris@82
|
9
|
|
Chris@82
|
10 Permission is granted to make and distribute verbatim copies of this
|
|
Chris@82
|
11 manual provided the copyright notice and this permission notice are
|
|
Chris@82
|
12 preserved on all copies.
|
|
Chris@82
|
13
|
|
Chris@82
|
14 Permission is granted to copy and distribute modified versions of this
|
|
Chris@82
|
15 manual under the conditions for verbatim copying, provided that the
|
|
Chris@82
|
16 entire resulting derived work is distributed under the terms of a
|
|
Chris@82
|
17 permission notice identical to this one.
|
|
Chris@82
|
18
|
|
Chris@82
|
19 Permission is granted to copy and distribute translations of this manual
|
|
Chris@82
|
20 into another language, under the above conditions for modified versions,
|
|
Chris@82
|
21 except that this permission notice may be stated in a translation
|
|
Chris@82
|
22 approved by the Free Software Foundation. -->
|
|
Chris@82
|
23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
|
|
Chris@82
|
24 <head>
|
|
Chris@82
|
25 <title>FFTW 3.3.8: Wisdom Export</title>
|
|
Chris@82
|
26
|
|
Chris@82
|
27 <meta name="description" content="FFTW 3.3.8: Wisdom Export">
|
|
Chris@82
|
28 <meta name="keywords" content="FFTW 3.3.8: Wisdom Export">
|
|
Chris@82
|
29 <meta name="resource-type" content="document">
|
|
Chris@82
|
30 <meta name="distribution" content="global">
|
|
Chris@82
|
31 <meta name="Generator" content="makeinfo">
|
|
Chris@82
|
32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
Chris@82
|
33 <link href="index.html#Top" rel="start" title="Top">
|
|
Chris@82
|
34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
|
|
Chris@82
|
35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
|
Chris@82
|
36 <link href="Wisdom.html#Wisdom" rel="up" title="Wisdom">
|
|
Chris@82
|
37 <link href="Wisdom-Import.html#Wisdom-Import" rel="next" title="Wisdom Import">
|
|
Chris@82
|
38 <link href="Wisdom.html#Wisdom" rel="prev" title="Wisdom">
|
|
Chris@82
|
39 <style type="text/css">
|
|
Chris@82
|
40 <!--
|
|
Chris@82
|
41 a.summary-letter {text-decoration: none}
|
|
Chris@82
|
42 blockquote.indentedblock {margin-right: 0em}
|
|
Chris@82
|
43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
|
|
Chris@82
|
44 blockquote.smallquotation {font-size: smaller}
|
|
Chris@82
|
45 div.display {margin-left: 3.2em}
|
|
Chris@82
|
46 div.example {margin-left: 3.2em}
|
|
Chris@82
|
47 div.lisp {margin-left: 3.2em}
|
|
Chris@82
|
48 div.smalldisplay {margin-left: 3.2em}
|
|
Chris@82
|
49 div.smallexample {margin-left: 3.2em}
|
|
Chris@82
|
50 div.smalllisp {margin-left: 3.2em}
|
|
Chris@82
|
51 kbd {font-style: oblique}
|
|
Chris@82
|
52 pre.display {font-family: inherit}
|
|
Chris@82
|
53 pre.format {font-family: inherit}
|
|
Chris@82
|
54 pre.menu-comment {font-family: serif}
|
|
Chris@82
|
55 pre.menu-preformatted {font-family: serif}
|
|
Chris@82
|
56 pre.smalldisplay {font-family: inherit; font-size: smaller}
|
|
Chris@82
|
57 pre.smallexample {font-size: smaller}
|
|
Chris@82
|
58 pre.smallformat {font-family: inherit; font-size: smaller}
|
|
Chris@82
|
59 pre.smalllisp {font-size: smaller}
|
|
Chris@82
|
60 span.nolinebreak {white-space: nowrap}
|
|
Chris@82
|
61 span.roman {font-family: initial; font-weight: normal}
|
|
Chris@82
|
62 span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
Chris@82
|
63 ul.no-bullet {list-style: none}
|
|
Chris@82
|
64 -->
|
|
Chris@82
|
65 </style>
|
|
Chris@82
|
66
|
|
Chris@82
|
67
|
|
Chris@82
|
68 </head>
|
|
Chris@82
|
69
|
|
Chris@82
|
70 <body lang="en">
|
|
Chris@82
|
71 <a name="Wisdom-Export"></a>
|
|
Chris@82
|
72 <div class="header">
|
|
Chris@82
|
73 <p>
|
|
Chris@82
|
74 Next: <a href="Wisdom-Import.html#Wisdom-Import" accesskey="n" rel="next">Wisdom Import</a>, Previous: <a href="Wisdom.html#Wisdom" accesskey="p" rel="prev">Wisdom</a>, Up: <a href="Wisdom.html#Wisdom" accesskey="u" rel="up">Wisdom</a> [<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@82
|
75 </div>
|
|
Chris@82
|
76 <hr>
|
|
Chris@82
|
77 <a name="Wisdom-Export-1"></a>
|
|
Chris@82
|
78 <h4 class="subsection">4.7.1 Wisdom Export</h4>
|
|
Chris@82
|
79
|
|
Chris@82
|
80 <div class="example">
|
|
Chris@82
|
81 <pre class="example">int fftw_export_wisdom_to_filename(const char *filename);
|
|
Chris@82
|
82 void fftw_export_wisdom_to_file(FILE *output_file);
|
|
Chris@82
|
83 char *fftw_export_wisdom_to_string(void);
|
|
Chris@82
|
84 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
|
|
Chris@82
|
85 </pre></div>
|
|
Chris@82
|
86 <a name="index-fftw_005fexport_005fwisdom"></a>
|
|
Chris@82
|
87 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-1"></a>
|
|
Chris@82
|
88 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffile"></a>
|
|
Chris@82
|
89 <a name="index-fftw_005fexport_005fwisdom_005fto_005fstring"></a>
|
|
Chris@82
|
90
|
|
Chris@82
|
91 <p>These functions allow you to export all currently accumulated wisdom
|
|
Chris@82
|
92 in a form from which it can be later imported and restored, even
|
|
Chris@82
|
93 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
|
|
Chris@82
|
94 of these routines.
|
|
Chris@82
|
95 </p>
|
|
Chris@82
|
96 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
|
|
Chris@82
|
97 medium, as specified by the callback function
|
|
Chris@82
|
98 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
|
|
Chris@82
|
99 writes the character <code>c</code> to some output; its second parameter is
|
|
Chris@82
|
100 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
|
|
Chris@82
|
101 convenience, the following three “wrapper” routines are provided:
|
|
Chris@82
|
102 </p>
|
|
Chris@82
|
103 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named
|
|
Chris@82
|
104 <code>filename</code> (which is created or overwritten), returning <code>1</code>
|
|
Chris@82
|
105 on success and <code>0</code> on failure. A lower-level function, which
|
|
Chris@82
|
106 requires you to open and close the file yourself (e.g. if you want to
|
|
Chris@82
|
107 write wisdom to a portion of a larger file) is
|
|
Chris@82
|
108 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the
|
|
Chris@82
|
109 current position in <code>output_file</code>, which should be open with
|
|
Chris@82
|
110 write permission; upon exit, the file remains open and is positioned
|
|
Chris@82
|
111 at the end of the wisdom data.
|
|
Chris@82
|
112 </p>
|
|
Chris@82
|
113 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
|
|
Chris@82
|
114 <code>NULL</code>-terminated string holding the wisdom data. This string is
|
|
Chris@82
|
115 dynamically allocated, and it is the responsibility of the caller to
|
|
Chris@82
|
116 deallocate it with <code>free</code> when it is no longer needed.
|
|
Chris@82
|
117 </p>
|
|
Chris@82
|
118 <p>All of these routines export the wisdom in the same format, which we
|
|
Chris@82
|
119 will not document here except to say that it is LISP-like ASCII text
|
|
Chris@82
|
120 that is insensitive to white space.
|
|
Chris@82
|
121 </p>
|
|
Chris@82
|
122 <hr>
|
|
Chris@82
|
123 <div class="header">
|
|
Chris@82
|
124 <p>
|
|
Chris@82
|
125 Next: <a href="Wisdom-Import.html#Wisdom-Import" accesskey="n" rel="next">Wisdom Import</a>, Previous: <a href="Wisdom.html#Wisdom" accesskey="p" rel="prev">Wisdom</a>, Up: <a href="Wisdom.html#Wisdom" accesskey="u" rel="up">Wisdom</a> [<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@82
|
126 </div>
|
|
Chris@82
|
127
|
|
Chris@82
|
128
|
|
Chris@82
|
129
|
|
Chris@82
|
130 </body>
|
|
Chris@82
|
131 </html>
|
