Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.3/doc/html/Wisdom-Import.html @ 10:37bf6b4a2645

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add FFTW3
author Chris Cannam
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
rev   line source
Chris@10 1 <html lang="en">
Chris@10 2 <head>
Chris@10 3 <title>Wisdom Import - FFTW 3.3.3</title>
Chris@10 4 <meta http-equiv="Content-Type" content="text/html">
Chris@10 5 <meta name="description" content="FFTW 3.3.3">
Chris@10 6 <meta name="generator" content="makeinfo 4.13">
Chris@10 7 <link title="Top" rel="start" href="index.html#Top">
Chris@10 8 <link rel="up" href="Wisdom.html#Wisdom" title="Wisdom">
Chris@10 9 <link rel="prev" href="Wisdom-Export.html#Wisdom-Export" title="Wisdom Export">
Chris@10 10 <link rel="next" href="Forgetting-Wisdom.html#Forgetting-Wisdom" title="Forgetting Wisdom">
Chris@10 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@10 12 <!--
Chris@10 13 This manual is for FFTW
Chris@10 14 (version 3.3.3, 25 November 2012).
Chris@10 15
Chris@10 16 Copyright (C) 2003 Matteo Frigo.
Chris@10 17
Chris@10 18 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@10 19
Chris@10 20 Permission is granted to make and distribute verbatim copies of
Chris@10 21 this manual provided the copyright notice and this permission
Chris@10 22 notice are preserved on all copies.
Chris@10 23
Chris@10 24 Permission is granted to copy and distribute modified versions of
Chris@10 25 this manual under the conditions for verbatim copying, provided
Chris@10 26 that the entire resulting derived work is distributed under the
Chris@10 27 terms of a permission notice identical to this one.
Chris@10 28
Chris@10 29 Permission is granted to copy and distribute translations of this
Chris@10 30 manual into another language, under the above conditions for
Chris@10 31 modified versions, except that this permission notice may be
Chris@10 32 stated in a translation approved by the Free Software Foundation.
Chris@10 33 -->
Chris@10 34 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@10 35 <style type="text/css"><!--
Chris@10 36 pre.display { font-family:inherit }
Chris@10 37 pre.format { font-family:inherit }
Chris@10 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@10 39 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@10 40 pre.smallexample { font-size:smaller }
Chris@10 41 pre.smalllisp { font-size:smaller }
Chris@10 42 span.sc { font-variant:small-caps }
Chris@10 43 span.roman { font-family:serif; font-weight:normal; }
Chris@10 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@10 45 --></style>
Chris@10 46 </head>
Chris@10 47 <body>
Chris@10 48 <div class="node">
Chris@10 49 <a name="Wisdom-Import"></a>
Chris@10 50 <p>
Chris@10 51 Next:&nbsp;<a rel="next" accesskey="n" href="Forgetting-Wisdom.html#Forgetting-Wisdom">Forgetting Wisdom</a>,
Chris@10 52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom-Export.html#Wisdom-Export">Wisdom Export</a>,
Chris@10 53 Up:&nbsp;<a rel="up" accesskey="u" href="Wisdom.html#Wisdom">Wisdom</a>
Chris@10 54 <hr>
Chris@10 55 </div>
Chris@10 56
Chris@10 57 <h4 class="subsection">4.7.2 Wisdom Import</h4>
Chris@10 58
Chris@10 59 <pre class="example"> int fftw_import_system_wisdom(void);
Chris@10 60 int fftw_import_wisdom_from_filename(const char *filename);
Chris@10 61 int fftw_import_wisdom_from_string(const char *input_string);
Chris@10 62 int fftw_import_wisdom(int (*read_char)(void *), void *data);
Chris@10 63 </pre>
Chris@10 64 <p><a name="index-fftw_005fimport_005fwisdom-282"></a><a name="index-fftw_005fimport_005fsystem_005fwisdom-283"></a><a name="index-fftw_005fimport_005fwisdom_005ffrom_005ffilename-284"></a><a name="index-fftw_005fimport_005fwisdom_005ffrom_005ffile-285"></a><a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring-286"></a>
Chris@10 65 These functions import wisdom into a program from data stored by the
Chris@10 66 <code>fftw_export_wisdom</code> functions above. (See <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans">Words of Wisdom-Saving Plans</a>.) The imported wisdom replaces any wisdom
Chris@10 67 already accumulated by the running program.
Chris@10 68
Chris@10 69 <p><code>fftw_import_wisdom</code> imports wisdom from any input medium, as
Chris@10 70 specified by the callback function <code>read_char</code>. <code>read_char</code> is
Chris@10 71 a <code>getc</code>-like function that returns the next character in the
Chris@10 72 input; its parameter is the <code>data</code> pointer passed to
Chris@10 73 <code>fftw_import_wisdom</code>. If the end of the input data is reached
Chris@10 74 (which should never happen for valid data), <code>read_char</code> should
Chris@10 75 return <code>EOF</code> (as defined in <code>&lt;stdio.h&gt;</code>). For convenience,
Chris@10 76 the following three &ldquo;wrapper&rdquo; routines are provided:
Chris@10 77
Chris@10 78 <p><code>fftw_import_wisdom_from_filename</code> reads wisdom from a file named
Chris@10 79 <code>filename</code>. A lower-level function, which requires you to open
Chris@10 80 and close the file yourself (e.g. if you want to read wisdom from a
Chris@10 81 portion of a larger file) is <code>fftw_import_wisdom_from_file</code>. This
Chris@10 82 reads wisdom from the current position in <code>input_file</code> (which
Chris@10 83 should be open with read permission); upon exit, the file remains
Chris@10 84 open, but the position of the read pointer is unspecified.
Chris@10 85
Chris@10 86 <p><code>fftw_import_wisdom_from_string</code> reads wisdom from the
Chris@10 87 <code>NULL</code>-terminated string <code>input_string</code>.
Chris@10 88
Chris@10 89 <p><code>fftw_import_system_wisdom</code> reads wisdom from an
Chris@10 90 implementation-defined standard file (<code>/etc/fftw/wisdom</code> on Unix
Chris@10 91 and GNU systems).
Chris@10 92 <a name="index-wisdom_002c-system_002dwide-287"></a>
Chris@10 93
Chris@10 94 <p>The return value of these import routines is <code>1</code> if the wisdom was
Chris@10 95 read successfully and <code>0</code> otherwise. Note that, in all of these
Chris@10 96 functions, any data in the input stream past the end of the wisdom data
Chris@10 97 is simply ignored.
Chris@10 98
Chris@10 99 <!-- =========> -->
Chris@10 100 </body></html>
Chris@10 101