annotate src/fftw-3.3.5/doc/html/Wisdom-of-Fortran_003f.html @ 79:91c729825bca pa_catalina

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