annotate src/fftw-3.3.8/doc/html/Wisdom-of-Fortran_003f.html @ 83:ae30d91d2ffe

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 d0c2a83c1364
children
rev   line source
Chris@82 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@82 2 <html>
Chris@82 3 <!-- This manual is for FFTW
Chris@82 4 (version 3.3.8, 24 May 2018).
Chris@82 5
Chris@82 6 Copyright (C) 2003 Matteo Frigo.
Chris@82 7
Chris@82 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@82 9
Chris@82 10 Permission is granted to make and distribute verbatim copies of this
Chris@82 11 manual provided the copyright notice and this permission notice are
Chris@82 12 preserved on all copies.
Chris@82 13
Chris@82 14 Permission is granted to copy and distribute modified versions of this
Chris@82 15 manual under the conditions for verbatim copying, provided that the
Chris@82 16 entire resulting derived work is distributed under the terms of a
Chris@82 17 permission notice identical to this one.
Chris@82 18
Chris@82 19 Permission is granted to copy and distribute translations of this manual
Chris@82 20 into another language, under the above conditions for modified versions,
Chris@82 21 except that this permission notice may be stated in a translation
Chris@82 22 approved by the Free Software Foundation. -->
Chris@82 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
Chris@82 24 <head>
Chris@82 25 <title>FFTW 3.3.8: Wisdom of Fortran?</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Wisdom of Fortran?">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Wisdom of Fortran?">
Chris@82 29 <meta name="resource-type" content="document">
Chris@82 30 <meta name="distribution" content="global">
Chris@82 31 <meta name="Generator" content="makeinfo">
Chris@82 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@82 33 <link href="index.html#Top" rel="start" title="Top">
Chris@82 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@82 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@82 36 <link href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran" rel="up" title="Calling FFTW from Legacy Fortran">
Chris@82 37 <link href="Upgrading-from-FFTW-version-2.html#Upgrading-from-FFTW-version-2" rel="next" title="Upgrading from FFTW version 2">
Chris@82 38 <link href="Fortran-Examples.html#Fortran-Examples" rel="prev" title="Fortran Examples">
Chris@82 39 <style type="text/css">
Chris@82 40 <!--
Chris@82 41 a.summary-letter {text-decoration: none}
Chris@82 42 blockquote.indentedblock {margin-right: 0em}
Chris@82 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
Chris@82 44 blockquote.smallquotation {font-size: smaller}
Chris@82 45 div.display {margin-left: 3.2em}
Chris@82 46 div.example {margin-left: 3.2em}
Chris@82 47 div.lisp {margin-left: 3.2em}
Chris@82 48 div.smalldisplay {margin-left: 3.2em}
Chris@82 49 div.smallexample {margin-left: 3.2em}
Chris@82 50 div.smalllisp {margin-left: 3.2em}
Chris@82 51 kbd {font-style: oblique}
Chris@82 52 pre.display {font-family: inherit}
Chris@82 53 pre.format {font-family: inherit}
Chris@82 54 pre.menu-comment {font-family: serif}
Chris@82 55 pre.menu-preformatted {font-family: serif}
Chris@82 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@82 57 pre.smallexample {font-size: smaller}
Chris@82 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@82 59 pre.smalllisp {font-size: smaller}
Chris@82 60 span.nolinebreak {white-space: nowrap}
Chris@82 61 span.roman {font-family: initial; font-weight: normal}
Chris@82 62 span.sansserif {font-family: sans-serif; font-weight: normal}
Chris@82 63 ul.no-bullet {list-style: none}
Chris@82 64 -->
Chris@82 65 </style>
Chris@82 66
Chris@82 67
Chris@82 68 </head>
Chris@82 69
Chris@82 70 <body lang="en">
Chris@82 71 <a name="Wisdom-of-Fortran_003f"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 Previous: <a href="Fortran-Examples.html#Fortran-Examples" accesskey="p" rel="prev">Fortran Examples</a>, Up: <a href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran" accesskey="u" rel="up">Calling FFTW from Legacy Fortran</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@82 75 </div>
Chris@82 76 <hr>
Chris@82 77 <a name="Wisdom-of-Fortran_003f-1"></a>
Chris@82 78 <h3 class="section">8.5 Wisdom of Fortran?</h3>
Chris@82 79
Chris@82 80 <p>In this section, we discuss how one can import/export FFTW wisdom
Chris@82 81 (saved plans) to/from a Fortran program; we assume that the reader is
Chris@82 82 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@82 83 </p>
Chris@82 84 <a name="index-portability-8"></a>
Chris@82 85 <p>The basic problem is that is difficult to (portably) pass files and
Chris@82 86 strings between Fortran and C, so we cannot provide a direct Fortran
Chris@82 87 equivalent to the <code>fftw_export_wisdom_to_file</code>, etcetera,
Chris@82 88 functions. Fortran interfaces <em>are</em> provided for the functions
Chris@82 89 that do not take file/string arguments, however:
Chris@82 90 <code>dfftw_import_system_wisdom</code>, <code>dfftw_import_wisdom</code>,
Chris@82 91 <code>dfftw_export_wisdom</code>, and <code>dfftw_forget_wisdom</code>.
Chris@82 92 <a name="index-dfftw_005fimport_005fsystem_005fwisdom"></a>
Chris@82 93 <a name="index-dfftw_005fimport_005fwisdom"></a>
Chris@82 94 <a name="index-dfftw_005fexport_005fwisdom"></a>
Chris@82 95 <a name="index-dfftw_005fforget_005fwisdom"></a>
Chris@82 96 </p>
Chris@82 97
Chris@82 98 <p>So, for example, to import the system-wide wisdom, you would do:
Chris@82 99 </p>
Chris@82 100 <div class="example">
Chris@82 101 <pre class="example"> integer isuccess
Chris@82 102 call dfftw_import_system_wisdom(isuccess)
Chris@82 103 </pre></div>
Chris@82 104
Chris@82 105 <p>As usual, the C return value is turned into a first parameter;
Chris@82 106 <code>isuccess</code> is non-zero on success and zero on failure (e.g. if
Chris@82 107 there is no system wisdom installed).
Chris@82 108 </p>
Chris@82 109 <p>If you want to import/export wisdom from/to an arbitrary file or
Chris@82 110 elsewhere, you can employ the generic <code>dfftw_import_wisdom</code> and
Chris@82 111 <code>dfftw_export_wisdom</code> functions, for which you must supply a
Chris@82 112 subroutine to read/write one character at a time. The FFTW package
Chris@82 113 contains an example file <code>doc/f77_wisdom.f</code> demonstrating how to
Chris@82 114 implement <code>import_wisdom_from_file</code> and
Chris@82 115 <code>export_wisdom_to_file</code> subroutines in this way. (These routines
Chris@82 116 cannot be compiled into the FFTW library itself, lest all FFTW-using
Chris@82 117 programs be required to link with the Fortran I/O library.)
Chris@82 118 </p>
Chris@82 119
Chris@82 120
Chris@82 121 </body>
Chris@82 122 </html>