annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Wisdom-Export.html.svn-base @ 9:262e084a15a9

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