Mercurial > hg > js-dsp-test

annotate fft/fftw/fftw-3.3.4/doc/html/Wisdom-Export.html @ 40:223f770b5341 kissfft-double tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Try a double-precision kissfft
author Chris Cannam
date Wed, 07 Sep 2016 10:40:32 +0100
parents 26056e866c29
children
rev   line source
Chris@19 1 <html lang="en">
Chris@19 2 <head>
Chris@19 3 <title>Wisdom Export - FFTW 3.3.4</title>
Chris@19 4 <meta http-equiv="Content-Type" content="text/html">
Chris@19 5 <meta name="description" content="FFTW 3.3.4">
Chris@19 6 <meta name="generator" content="makeinfo 4.13">
Chris@19 7 <link title="Top" rel="start" href="index.html#Top">
Chris@19 8 <link rel="up" href="Wisdom.html#Wisdom" title="Wisdom">
Chris@19 9 <link rel="prev" href="Wisdom.html#Wisdom" title="Wisdom">
Chris@19 10 <link rel="next" href="Wisdom-Import.html#Wisdom-Import" title="Wisdom Import">
Chris@19 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@19 12 <!--
Chris@19 13 This manual is for FFTW
Chris@19 14 (version 3.3.4, 20 September 2013).
Chris@19 15
Chris@19 16 Copyright (C) 2003 Matteo Frigo.
Chris@19 17
Chris@19 18 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@19 19
Chris@19 20 Permission is granted to make and distribute verbatim copies of
Chris@19 21 this manual provided the copyright notice and this permission
Chris@19 22 notice are preserved on all copies.
Chris@19 23
Chris@19 24 Permission is granted to copy and distribute modified versions of
Chris@19 25 this manual under the conditions for verbatim copying, provided
Chris@19 26 that the entire resulting derived work is distributed under the
Chris@19 27 terms of a permission notice identical to this one.
Chris@19 28
Chris@19 29 Permission is granted to copy and distribute translations of this
Chris@19 30 manual into another language, under the above conditions for
Chris@19 31 modified versions, except that this permission notice may be
Chris@19 32 stated in a translation approved by the Free Software Foundation.
Chris@19 33 -->
Chris@19 34 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@19 35 <style type="text/css"><!--
Chris@19 36 pre.display { font-family:inherit }
Chris@19 37 pre.format { font-family:inherit }
Chris@19 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@19 39 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@19 40 pre.smallexample { font-size:smaller }
Chris@19 41 pre.smalllisp { font-size:smaller }
Chris@19 42 span.sc { font-variant:small-caps }
Chris@19 43 span.roman { font-family:serif; font-weight:normal; }
Chris@19 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@19 45 --></style>
Chris@19 46 </head>
Chris@19 47 <body>
Chris@19 48 <div class="node">
Chris@19 49 <a name="Wisdom-Export"></a>
Chris@19 50 <p>
Chris@19 51 Next:&nbsp;<a rel="next" accesskey="n" href="Wisdom-Import.html#Wisdom-Import">Wisdom Import</a>,
Chris@19 52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom.html#Wisdom">Wisdom</a>,
Chris@19 53 Up:&nbsp;<a rel="up" accesskey="u" href="Wisdom.html#Wisdom">Wisdom</a>
Chris@19 54 <hr>
Chris@19 55 </div>
Chris@19 56
Chris@19 57 <h4 class="subsection">4.7.1 Wisdom Export</h4>
Chris@19 58
Chris@19 59 <pre class="example"> int fftw_export_wisdom_to_filename(const char *filename);
Chris@19 60 void fftw_export_wisdom_to_file(FILE *output_file);
Chris@19 61 char *fftw_export_wisdom_to_string(void);
Chris@19 62 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
Chris@19 63 </pre>
Chris@19 64 <p><a name="index-fftw_005fexport_005fwisdom-281"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-282"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffile-283"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-284"></a>
Chris@19 65 These functions allow you to export all currently accumulated wisdom
Chris@19 66 in a form from which it can be later imported and restored, even
Chris@19 67 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@19 68 of these routines.
Chris@19 69
Chris@19 70 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
Chris@19 71 medium, as specified by the callback function
Chris@19 72 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
Chris@19 73 writes the character <code>c</code> to some output; its second parameter is
Chris@19 74 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
Chris@19 75 convenience, the following three &ldquo;wrapper&rdquo; routines are provided:
Chris@19 76
Chris@19 77 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named
Chris@19 78 <code>filename</code> (which is created or overwritten), returning <code>1</code>
Chris@19 79 on success and <code>0</code> on failure. A lower-level function, which
Chris@19 80 requires you to open and close the file yourself (e.g. if you want to
Chris@19 81 write wisdom to a portion of a larger file) is
Chris@19 82 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the
Chris@19 83 current position in <code>output_file</code>, which should be open with
Chris@19 84 write permission; upon exit, the file remains open and is positioned
Chris@19 85 at the end of the wisdom data.
Chris@19 86
Chris@19 87 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
Chris@19 88 <code>NULL</code>-terminated string holding the wisdom data. This string is
Chris@19 89 dynamically allocated, and it is the responsibility of the caller to
Chris@19 90 deallocate it with <code>free</code> when it is no longer needed.
Chris@19 91
Chris@19 92 <p>All of these routines export the wisdom in the same format, which we
Chris@19 93 will not document here except to say that it is LISP-like ASCII text
Chris@19 94 that is insensitive to white space.
Chris@19 95
Chris@19 96 <!-- =========> -->
Chris@19 97 </body></html>
Chris@19 98