comparison Lib/fftw-3.2.1/doc/html/.svn/text-base/Wisdom-Export.html.svn-base @ 0:25bf17994ef1

First commit. VS2013, Codeblocks and Mac OSX configuration
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Thu, 09 Jul 2015 01:12:16 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:25bf17994ef1
1 <html lang="en">
2 <head>
3 <title>Wisdom Export - FFTW 3.2.1</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="FFTW 3.2.1">
6 <meta name="generator" content="makeinfo 4.8">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Wisdom.html#Wisdom" title="Wisdom">
9 <link rel="prev" href="Wisdom.html#Wisdom" title="Wisdom">
10 <link rel="next" href="Wisdom-Import.html#Wisdom-Import" title="Wisdom Import">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <!--
13 This manual is for FFTW
14 (version 3.2.1, 5 February 2009).
15
16 Copyright (C) 2003 Matteo Frigo.
17
18 Copyright (C) 2003 Massachusetts Institute of Technology.
19
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission
22 notice are preserved on all copies.
23
24 Permission is granted to copy and distribute modified versions of
25 this manual under the conditions for verbatim copying, provided
26 that the entire resulting derived work is distributed under the
27 terms of a permission notice identical to this one.
28
29 Permission is granted to copy and distribute translations of this
30 manual into another language, under the above conditions for
31 modified versions, except that this permission notice may be
32 stated in a translation approved by the Free Software Foundation.
33 -->
34 <meta http-equiv="Content-Style-Type" content="text/css">
35 <style type="text/css"><!--
36 pre.display { font-family:inherit }
37 pre.format { font-family:inherit }
38 pre.smalldisplay { font-family:inherit; font-size:smaller }
39 pre.smallformat { font-family:inherit; font-size:smaller }
40 pre.smallexample { font-size:smaller }
41 pre.smalllisp { font-size:smaller }
42 span.sc { font-variant:small-caps }
43 span.roman { font-family:serif; font-weight:normal; }
44 span.sansserif { font-family:sans-serif; font-weight:normal; }
45 --></style>
46 </head>
47 <body>
48 <div class="node">
49 <p>
50 <a name="Wisdom-Export"></a>
51 Next:&nbsp;<a rel="next" accesskey="n" href="Wisdom-Import.html#Wisdom-Import">Wisdom Import</a>,
52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom.html#Wisdom">Wisdom</a>,
53 Up:&nbsp;<a rel="up" accesskey="u" href="Wisdom.html#Wisdom">Wisdom</a>
54 <hr>
55 </div>
56
57 <h4 class="subsection">4.7.1 Wisdom Export</h4>
58
59 <pre class="example"> void fftw_export_wisdom_to_file(FILE *output_file);
60 char *fftw_export_wisdom_to_string(void);
61 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
62 </pre>
63 <p><a name="index-fftw_005fexport_005fwisdom-270"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffile-271"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-272"></a>
64 These functions allow you to export all currently accumulated wisdom
65 in a form from which it can be later imported and restored, even
66 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
67 of these routines.
68
69 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
70 medium, as specified by the callback function
71 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
72 writes the character <code>c</code> to some output; its second parameter is
73 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
74 convenience, the following two &ldquo;wrapper&rdquo; routines are provided:
75
76 <p><code>fftw_export_wisdom_to_file</code> writes the wisdom to the
77 current position in <code>output_file</code>, which should be open with write
78 permission. Upon exit, the file remains open and is positioned at the
79 end of the wisdom data.
80
81 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
82 <code>NULL</code>-terminated string holding the wisdom data. This string is
83 dynamically allocated, and it is the responsibility of the caller to
84 deallocate it with <code>free</code> when it is no longer needed.
85
86 <p>All of these routines export the wisdom in the same format, which we
87 will not document here except to say that it is LISP-like ASCII text
88 that is insensitive to white space.
89
90 <!-- =========> -->
91 </body></html>
92