annotate fft/fftw/fftw-3.3.4/doc/html/Wisdom-of-Fortran_003f.html @ 40:223f770b5341 kissfft-double tip

Try a double-precision kissfft
author Chris Cannam
date Wed, 07 Sep 2016 10:40:32 +0100
parents 26056e866c29
children
rev   line source
Chris@19 1 <html lang="en">
Chris@19 2 <head>
Chris@19 3 <title>Wisdom of Fortran? - FFTW 3.3.4</title>
Chris@19 4 <meta http-equiv="Content-Type" content="text/html">
Chris@19 5 <meta name="description" content="FFTW 3.3.4">
Chris@19 6 <meta name="generator" content="makeinfo 4.13">
Chris@19 7 <link title="Top" rel="start" href="index.html#Top">
Chris@19 8 <link rel="up" href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran" title="Calling FFTW from Legacy Fortran">
Chris@19 9 <link rel="prev" href="Fortran-Examples.html#Fortran-Examples" title="Fortran Examples">
Chris@19 10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@19 11 <!--
Chris@19 12 This manual is for FFTW
Chris@19 13 (version 3.3.4, 20 September 2013).
Chris@19 14
Chris@19 15 Copyright (C) 2003 Matteo Frigo.
Chris@19 16
Chris@19 17 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@19 18
Chris@19 19 Permission is granted to make and distribute verbatim copies of
Chris@19 20 this manual provided the copyright notice and this permission
Chris@19 21 notice are preserved on all copies.
Chris@19 22
Chris@19 23 Permission is granted to copy and distribute modified versions of
Chris@19 24 this manual under the conditions for verbatim copying, provided
Chris@19 25 that the entire resulting derived work is distributed under the
Chris@19 26 terms of a permission notice identical to this one.
Chris@19 27
Chris@19 28 Permission is granted to copy and distribute translations of this
Chris@19 29 manual into another language, under the above conditions for
Chris@19 30 modified versions, except that this permission notice may be
Chris@19 31 stated in a translation approved by the Free Software Foundation.
Chris@19 32 -->
Chris@19 33 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@19 34 <style type="text/css"><!--
Chris@19 35 pre.display { font-family:inherit }
Chris@19 36 pre.format { font-family:inherit }
Chris@19 37 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@19 38 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@19 39 pre.smallexample { font-size:smaller }
Chris@19 40 pre.smalllisp { font-size:smaller }
Chris@19 41 span.sc { font-variant:small-caps }
Chris@19 42 span.roman { font-family:serif; font-weight:normal; }
Chris@19 43 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@19 44 --></style>
Chris@19 45 </head>
Chris@19 46 <body>
Chris@19 47 <div class="node">
Chris@19 48 <a name="Wisdom-of-Fortran%3f"></a>
Chris@19 49 <a name="Wisdom-of-Fortran_003f"></a>
Chris@19 50 <p>
Chris@19 51 Previous:&nbsp;<a rel="previous" accesskey="p" href="Fortran-Examples.html#Fortran-Examples">Fortran Examples</a>,
Chris@19 52 Up:&nbsp;<a rel="up" accesskey="u" href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran">Calling FFTW from Legacy Fortran</a>
Chris@19 53 <hr>
Chris@19 54 </div>
Chris@19 55
Chris@19 56 <h3 class="section">8.5 Wisdom of Fortran?</h3>
Chris@19 57
Chris@19 58 <p>In this section, we discuss how one can import/export FFTW wisdom
Chris@19 59 (saved plans) to/from a Fortran program; we assume that the reader is
Chris@19 60 already familiar with wisdom, as described in <a href="Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans">Words of Wisdom-Saving Plans</a>.
Chris@19 61
Chris@19 62 <p><a name="index-portability-601"></a>The basic problem is that is difficult to (portably) pass files and
Chris@19 63 strings between Fortran and C, so we cannot provide a direct Fortran
Chris@19 64 equivalent to the <code>fftw_export_wisdom_to_file</code>, etcetera,
Chris@19 65 functions. Fortran interfaces <em>are</em> provided for the functions
Chris@19 66 that do not take file/string arguments, however:
Chris@19 67 <code>dfftw_import_system_wisdom</code>, <code>dfftw_import_wisdom</code>,
Chris@19 68 <code>dfftw_export_wisdom</code>, and <code>dfftw_forget_wisdom</code>.
Chris@19 69 <a name="index-dfftw_005fimport_005fsystem_005fwisdom-602"></a><a name="index-dfftw_005fimport_005fwisdom-603"></a><a name="index-dfftw_005fexport_005fwisdom-604"></a><a name="index-dfftw_005fforget_005fwisdom-605"></a>
Chris@19 70
Chris@19 71 <p>So, for example, to import the system-wide wisdom, you would do:
Chris@19 72
Chris@19 73 <pre class="example"> integer isuccess
Chris@19 74 call dfftw_import_system_wisdom(isuccess)
Chris@19 75 </pre>
Chris@19 76 <p>As usual, the C return value is turned into a first parameter;
Chris@19 77 <code>isuccess</code> is non-zero on success and zero on failure (e.g. if
Chris@19 78 there is no system wisdom installed).
Chris@19 79
Chris@19 80 <p>If you want to import/export wisdom from/to an arbitrary file or
Chris@19 81 elsewhere, you can employ the generic <code>dfftw_import_wisdom</code> and
Chris@19 82 <code>dfftw_export_wisdom</code> functions, for which you must supply a
Chris@19 83 subroutine to read/write one character at a time. The FFTW package
Chris@19 84 contains an example file <code>doc/f77_wisdom.f</code> demonstrating how to
Chris@19 85 implement <code>import_wisdom_from_file</code> and
Chris@19 86 <code>export_wisdom_to_file</code> subroutines in this way. (These routines
Chris@19 87 cannot be compiled into the FFTW library itself, lest all FFTW-using
Chris@19 88 programs be required to link with the Fortran I/O library.)
Chris@19 89
Chris@19 90 </body></html>
Chris@19 91