Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Wisdom-Export.html @ 127:7867fa7e1b6b

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