annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Wisdom-of-Fortran_003f.html.svn-base @ 4:345acbd06029

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