Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.8/doc/html/Wisdom-Export.html @ 167:bd3cc4d1df30

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