Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Wisdom-of-Fortran_003f.html @ 169:223a55898ab9 tip default

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