Chris@10: <html lang="en">
Chris@10: <head>
Chris@10: <title>Wisdom Import - FFTW 3.3.3</title>
Chris@10: <meta http-equiv="Content-Type" content="text/html">
Chris@10: <meta name="description" content="FFTW 3.3.3">
Chris@10: <meta name="generator" content="makeinfo 4.13">
Chris@10: <link title="Top" rel="start" href="index.html#Top">
Chris@10: <link rel="up" href="Wisdom.html#Wisdom" title="Wisdom">
Chris@10: <link rel="prev" href="Wisdom-Export.html#Wisdom-Export" title="Wisdom Export">
Chris@10: <link rel="next" href="Forgetting-Wisdom.html#Forgetting-Wisdom" title="Forgetting Wisdom">
Chris@10: <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@10: <!--
Chris@10: This manual is for FFTW
Chris@10: (version 3.3.3, 25 November 2012).
Chris@10:
Chris@10: Copyright (C) 2003 Matteo Frigo.
Chris@10:
Chris@10: Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@10:
Chris@10: Permission is granted to make and distribute verbatim copies of
Chris@10: this manual provided the copyright notice and this permission
Chris@10: notice are preserved on all copies.
Chris@10:
Chris@10: Permission is granted to copy and distribute modified versions of
Chris@10: this manual under the conditions for verbatim copying, provided
Chris@10: that the entire resulting derived work is distributed under the
Chris@10: terms of a permission notice identical to this one.
Chris@10:
Chris@10: Permission is granted to copy and distribute translations of this
Chris@10: manual into another language, under the above conditions for
Chris@10: modified versions, except that this permission notice may be
Chris@10: stated in a translation approved by the Free Software Foundation.
Chris@10: -->
Chris@10: <meta http-equiv="Content-Style-Type" content="text/css">
Chris@10: <style type="text/css"><!--
Chris@10: pre.display { font-family:inherit }
Chris@10: pre.format { font-family:inherit }
Chris@10: pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@10: pre.smallformat { font-family:inherit; font-size:smaller }
Chris@10: pre.smallexample { font-size:smaller }
Chris@10: pre.smalllisp { font-size:smaller }
Chris@10: span.sc { font-variant:small-caps }
Chris@10: span.roman { font-family:serif; font-weight:normal; }
Chris@10: span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@10: --></style>
Chris@10: </head>
Chris@10: <body>
Chris@10: <div class="node">
Chris@10: <a name="Wisdom-Import"></a>
Chris@10: <p>
Chris@10: Next: <a rel="next" accesskey="n" href="Forgetting-Wisdom.html#Forgetting-Wisdom">Forgetting Wisdom</a>,
Chris@10: Previous: <a rel="previous" accesskey="p" href="Wisdom-Export.html#Wisdom-Export">Wisdom Export</a>,
Chris@10: Up: <a rel="up" accesskey="u" href="Wisdom.html#Wisdom">Wisdom</a>
Chris@10: <hr>
Chris@10: </div>
Chris@10:
Chris@10: <h4 class="subsection">4.7.2 Wisdom Import</h4>
Chris@10:
Chris@10: <pre class="example"> int fftw_import_system_wisdom(void);
Chris@10: int fftw_import_wisdom_from_filename(const char *filename);
Chris@10: int fftw_import_wisdom_from_string(const char *input_string);
Chris@10: int fftw_import_wisdom(int (*read_char)(void *), void *data);
Chris@10: </pre>
Chris@10: <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: These functions import wisdom into a program from data stored by the
Chris@10: <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: already accumulated by the running program.
Chris@10:
Chris@10: <p><code>fftw_import_wisdom</code> imports wisdom from any input medium, as
Chris@10: specified by the callback function <code>read_char</code>. <code>read_char</code> is
Chris@10: a <code>getc</code>-like function that returns the next character in the
Chris@10: input; its parameter is the <code>data</code> pointer passed to
Chris@10: <code>fftw_import_wisdom</code>. If the end of the input data is reached
Chris@10: (which should never happen for valid data), <code>read_char</code> should
Chris@10: return <code>EOF</code> (as defined in <code><stdio.h></code>). For convenience,
Chris@10: the following three “wrapper” routines are provided:
Chris@10:
Chris@10: <p><code>fftw_import_wisdom_from_filename</code> reads wisdom from a file named
Chris@10: <code>filename</code>. A lower-level function, which requires you to open
Chris@10: and close the file yourself (e.g. if you want to read wisdom from a
Chris@10: portion of a larger file) is <code>fftw_import_wisdom_from_file</code>. This
Chris@10: reads wisdom from the current position in <code>input_file</code> (which
Chris@10: should be open with read permission); upon exit, the file remains
Chris@10: open, but the position of the read pointer is unspecified.
Chris@10:
Chris@10: <p><code>fftw_import_wisdom_from_string</code> reads wisdom from the
Chris@10: <code>NULL</code>-terminated string <code>input_string</code>.
Chris@10:
Chris@10: <p><code>fftw_import_system_wisdom</code> reads wisdom from an
Chris@10: implementation-defined standard file (<code>/etc/fftw/wisdom</code> on Unix
Chris@10: and GNU systems).
Chris@10: <a name="index-wisdom_002c-system_002dwide-287"></a>
Chris@10:
Chris@10: <p>The return value of these import routines is <code>1</code> if the wisdom was
Chris@10: read successfully and <code>0</code> otherwise. Note that, in all of these
Chris@10: functions, any data in the input stream past the end of the wisdom data
Chris@10: is simply ignored.
Chris@10:
Chris@10: <!-- =========> -->
Chris@10: </body></html>
Chris@10: