Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Wisdom-Export.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
126:4a7071416412 127:7867fa7e1b6b
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.5, 30 July 2016).
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 5.2, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.5: Wisdom Export</title>
26
27 <meta name="description" content="FFTW 3.3.5: Wisdom Export">
28 <meta name="keywords" content="FFTW 3.3.5: 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.smallquotation {font-size: smaller}
43 div.display {margin-left: 3.2em}
44 div.example {margin-left: 3.2em}
45 div.indentedblock {margin-left: 3.2em}
46 div.lisp {margin-left: 3.2em}
47 div.smalldisplay {margin-left: 3.2em}
48 div.smallexample {margin-left: 3.2em}
49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
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.nocodebreak {white-space:nowrap}
61 span.nolinebreak {white-space:nowrap}
62 span.roman {font-family:serif; font-weight:normal}
63 span.sansserif {font-family:sans-serif; font-weight:normal}
64 ul.no-bullet {list-style: none}
65 -->
66 </style>
67
68
69 </head>
70
71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
72 <a name="Wisdom-Export"></a>
73 <div class="header">
74 <p>
75 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>
76 </div>
77 <hr>
78 <a name="Wisdom-Export-1"></a>
79 <h4 class="subsection">4.7.1 Wisdom Export</h4>
80
81 <div class="example">
82 <pre class="example">int fftw_export_wisdom_to_filename(const char *filename);
83 void fftw_export_wisdom_to_file(FILE *output_file);
84 char *fftw_export_wisdom_to_string(void);
85 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
86 </pre></div>
87 <a name="index-fftw_005fexport_005fwisdom"></a>
88 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-1"></a>
89 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffile"></a>
90 <a name="index-fftw_005fexport_005fwisdom_005fto_005fstring"></a>
91
92 <p>These functions allow you to export all currently accumulated wisdom
93 in a form from which it can be later imported and restored, even
94 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
95 of these routines.
96 </p>
97 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
98 medium, as specified by the callback function
99 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
100 writes the character <code>c</code> to some output; its second parameter is
101 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
102 convenience, the following three &ldquo;wrapper&rdquo; routines are provided:
103 </p>
104 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named
105 <code>filename</code> (which is created or overwritten), returning <code>1</code>
106 on success and <code>0</code> on failure. A lower-level function, which
107 requires you to open and close the file yourself (e.g. if you want to
108 write wisdom to a portion of a larger file) is
109 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the
110 current position in <code>output_file</code>, which should be open with
111 write permission; upon exit, the file remains open and is positioned
112 at the end of the wisdom data.
113 </p>
114 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
115 <code>NULL</code>-terminated string holding the wisdom data. This string is
116 dynamically allocated, and it is the responsibility of the caller to
117 deallocate it with <code>free</code> when it is no longer needed.
118 </p>
119 <p>All of these routines export the wisdom in the same format, which we
120 will not document here except to say that it is LISP-like ASCII text
121 that is insensitive to white space.
122 </p>
123 <hr>
124 <div class="header">
125 <p>
126 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>
127 </div>
128
129
130
131 </body>
132 </html>