Mercurial > hg > sv-dependency-builds
comparison src/fftw-3.3.3/doc/html/Wisdom-Export.html @ 10:37bf6b4a2645
Add FFTW3
| author | Chris Cannam |
|---|---|
| date | Wed, 20 Mar 2013 15:35:50 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 9:c0fb53affa76 | 10:37bf6b4a2645 |
|---|---|
| 1 <html lang="en"> | |
| 2 <head> | |
| 3 <title>Wisdom Export - FFTW 3.3.3</title> | |
| 4 <meta http-equiv="Content-Type" content="text/html"> | |
| 5 <meta name="description" content="FFTW 3.3.3"> | |
| 6 <meta name="generator" content="makeinfo 4.13"> | |
| 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.3.3, 25 November 2012). | |
| 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 <a name="Wisdom-Export"></a> | |
| 50 <p> | |
| 51 Next: <a rel="next" accesskey="n" href="Wisdom-Import.html#Wisdom-Import">Wisdom Import</a>, | |
| 52 Previous: <a rel="previous" accesskey="p" href="Wisdom.html#Wisdom">Wisdom</a>, | |
| 53 Up: <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"> int fftw_export_wisdom_to_filename(const char *filename); | |
| 60 void fftw_export_wisdom_to_file(FILE *output_file); | |
| 61 char *fftw_export_wisdom_to_string(void); | |
| 62 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data); | |
| 63 </pre> | |
| 64 <p><a name="index-fftw_005fexport_005fwisdom-278"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-279"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffile-280"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-281"></a> | |
| 65 These functions allow you to export all currently accumulated wisdom | |
| 66 in a form from which it can be later imported and restored, even | |
| 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 | |
| 68 of these routines. | |
| 69 | |
| 70 <p><code>fftw_export_wisdom</code> exports the wisdom to any output | |
| 71 medium, as specified by the callback function | |
| 72 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that | |
| 73 writes the character <code>c</code> to some output; its second parameter is | |
| 74 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For | |
| 75 convenience, the following three “wrapper” routines are provided: | |
| 76 | |
| 77 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named | |
| 78 <code>filename</code> (which is created or overwritten), returning <code>1</code> | |
| 79 on success and <code>0</code> on failure. A lower-level function, which | |
| 80 requires you to open and close the file yourself (e.g. if you want to | |
| 81 write wisdom to a portion of a larger file) is | |
| 82 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the | |
| 83 current position in <code>output_file</code>, which should be open with | |
| 84 write permission; upon exit, the file remains open and is positioned | |
| 85 at the end of the wisdom data. | |
| 86 | |
| 87 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a | |
| 88 <code>NULL</code>-terminated string holding the wisdom data. This string is | |
| 89 dynamically allocated, and it is the responsibility of the caller to | |
| 90 deallocate it with <code>free</code> when it is no longer needed. | |
| 91 | |
| 92 <p>All of these routines export the wisdom in the same format, which we | |
| 93 will not document here except to say that it is LISP-like ASCII text | |
| 94 that is insensitive to white space. | |
| 95 | |
| 96 <!-- =========> --> | |
| 97 </body></html> | |
| 98 |