Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Wisdom-Export.html @ 83:ae30d91d2ffe

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