Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Wisdom-Export.html @ 167:bd3cc4d1df30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
cannam@167 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@167 2 <html>
cannam@167 3 <!-- This manual is for FFTW
cannam@167 4 (version 3.3.8, 24 May 2018).
cannam@167 5
cannam@167 6 Copyright (C) 2003 Matteo Frigo.
cannam@167 7
cannam@167 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@167 9
cannam@167 10 Permission is granted to make and distribute verbatim copies of this
cannam@167 11 manual provided the copyright notice and this permission notice are
cannam@167 12 preserved on all copies.
cannam@167 13
cannam@167 14 Permission is granted to copy and distribute modified versions of this
cannam@167 15 manual under the conditions for verbatim copying, provided that the
cannam@167 16 entire resulting derived work is distributed under the terms of a
cannam@167 17 permission notice identical to this one.
cannam@167 18
cannam@167 19 Permission is granted to copy and distribute translations of this manual
cannam@167 20 into another language, under the above conditions for modified versions,
cannam@167 21 except that this permission notice may be stated in a translation
cannam@167 22 approved by the Free Software Foundation. -->
cannam@167 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
cannam@167 24 <head>
cannam@167 25 <title>FFTW 3.3.8: Wisdom Export</title>
cannam@167 26
cannam@167 27 <meta name="description" content="FFTW 3.3.8: Wisdom Export">
cannam@167 28 <meta name="keywords" content="FFTW 3.3.8: Wisdom Export">
cannam@167 29 <meta name="resource-type" content="document">
cannam@167 30 <meta name="distribution" content="global">
cannam@167 31 <meta name="Generator" content="makeinfo">
cannam@167 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@167 33 <link href="index.html#Top" rel="start" title="Top">
cannam@167 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@167 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@167 36 <link href="Wisdom.html#Wisdom" rel="up" title="Wisdom">
cannam@167 37 <link href="Wisdom-Import.html#Wisdom-Import" rel="next" title="Wisdom Import">
cannam@167 38 <link href="Wisdom.html#Wisdom" rel="prev" title="Wisdom">
cannam@167 39 <style type="text/css">
cannam@167 40 <!--
cannam@167 41 a.summary-letter {text-decoration: none}
cannam@167 42 blockquote.indentedblock {margin-right: 0em}
cannam@167 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
cannam@167 44 blockquote.smallquotation {font-size: smaller}
cannam@167 45 div.display {margin-left: 3.2em}
cannam@167 46 div.example {margin-left: 3.2em}
cannam@167 47 div.lisp {margin-left: 3.2em}
cannam@167 48 div.smalldisplay {margin-left: 3.2em}
cannam@167 49 div.smallexample {margin-left: 3.2em}
cannam@167 50 div.smalllisp {margin-left: 3.2em}
cannam@167 51 kbd {font-style: oblique}
cannam@167 52 pre.display {font-family: inherit}
cannam@167 53 pre.format {font-family: inherit}
cannam@167 54 pre.menu-comment {font-family: serif}
cannam@167 55 pre.menu-preformatted {font-family: serif}
cannam@167 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@167 57 pre.smallexample {font-size: smaller}
cannam@167 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@167 59 pre.smalllisp {font-size: smaller}
cannam@167 60 span.nolinebreak {white-space: nowrap}
cannam@167 61 span.roman {font-family: initial; font-weight: normal}
cannam@167 62 span.sansserif {font-family: sans-serif; font-weight: normal}
cannam@167 63 ul.no-bullet {list-style: none}
cannam@167 64 -->
cannam@167 65 </style>
cannam@167 66
cannam@167 67
cannam@167 68 </head>
cannam@167 69
cannam@167 70 <body lang="en">
cannam@167 71 <a name="Wisdom-Export"></a>
cannam@167 72 <div class="header">
cannam@167 73 <p>
cannam@167 74 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>
cannam@167 75 </div>
cannam@167 76 <hr>
cannam@167 77 <a name="Wisdom-Export-1"></a>
cannam@167 78 <h4 class="subsection">4.7.1 Wisdom Export</h4>
cannam@167 79
cannam@167 80 <div class="example">
cannam@167 81 <pre class="example">int fftw_export_wisdom_to_filename(const char *filename);
cannam@167 82 void fftw_export_wisdom_to_file(FILE *output_file);
cannam@167 83 char *fftw_export_wisdom_to_string(void);
cannam@167 84 void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
cannam@167 85 </pre></div>
cannam@167 86 <a name="index-fftw_005fexport_005fwisdom"></a>
cannam@167 87 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-1"></a>
cannam@167 88 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffile"></a>
cannam@167 89 <a name="index-fftw_005fexport_005fwisdom_005fto_005fstring"></a>
cannam@167 90
cannam@167 91 <p>These functions allow you to export all currently accumulated wisdom
cannam@167 92 in a form from which it can be later imported and restored, even
cannam@167 93 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
cannam@167 94 of these routines.
cannam@167 95 </p>
cannam@167 96 <p><code>fftw_export_wisdom</code> exports the wisdom to any output
cannam@167 97 medium, as specified by the callback function
cannam@167 98 <code>write_char</code>. <code>write_char</code> is a <code>putc</code>-like function that
cannam@167 99 writes the character <code>c</code> to some output; its second parameter is
cannam@167 100 the <code>data</code> pointer passed to <code>fftw_export_wisdom</code>. For
cannam@167 101 convenience, the following three &ldquo;wrapper&rdquo; routines are provided:
cannam@167 102 </p>
cannam@167 103 <p><code>fftw_export_wisdom_to_filename</code> writes wisdom to a file named
cannam@167 104 <code>filename</code> (which is created or overwritten), returning <code>1</code>
cannam@167 105 on success and <code>0</code> on failure. A lower-level function, which
cannam@167 106 requires you to open and close the file yourself (e.g. if you want to
cannam@167 107 write wisdom to a portion of a larger file) is
cannam@167 108 <code>fftw_export_wisdom_to_file</code>. This writes the wisdom to the
cannam@167 109 current position in <code>output_file</code>, which should be open with
cannam@167 110 write permission; upon exit, the file remains open and is positioned
cannam@167 111 at the end of the wisdom data.
cannam@167 112 </p>
cannam@167 113 <p><code>fftw_export_wisdom_to_string</code> returns a pointer to a
cannam@167 114 <code>NULL</code>-terminated string holding the wisdom data. This string is
cannam@167 115 dynamically allocated, and it is the responsibility of the caller to
cannam@167 116 deallocate it with <code>free</code> when it is no longer needed.
cannam@167 117 </p>
cannam@167 118 <p>All of these routines export the wisdom in the same format, which we
cannam@167 119 will not document here except to say that it is LISP-like ASCII text
cannam@167 120 that is insensitive to white space.
cannam@167 121 </p>
cannam@167 122 <hr>
cannam@167 123 <div class="header">
cannam@167 124 <p>
cannam@167 125 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>
cannam@167 126 </div>
cannam@167 127
cannam@167 128
cannam@167 129
cannam@167 130 </body>
cannam@167 131 </html>