Mercurial > hg > sv-dependency-builds

diff src/fftw-3.3.8/doc/html/Wisdom-of-Fortran_003f.html @ 167:bd3cc4d1df30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/fftw-3.3.8/doc/html/Wisdom-of-Fortran_003f.html	Tue Nov 19 14:52:55 2019 +0000
@@ -0,0 +1,122 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- This manual is for FFTW
+(version 3.3.8, 24 May 2018).
+
+Copyright (C) 2003 Matteo Frigo.
+
+Copyright (C) 2003 Massachusetts Institute of Technology.
+
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+
+Permission is granted to copy and distribute modified versions of this
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
+
+Permission is granted to copy and distribute translations of this manual
+into another language, under the above conditions for modified versions,
+except that this permission notice may be stated in a translation
+approved by the Free Software Foundation. -->
+<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>FFTW 3.3.8: Wisdom of Fortran?</title>
+
+<meta name="description" content="FFTW 3.3.8: Wisdom of Fortran?">
+<meta name="keywords" content="FFTW 3.3.8: Wisdom of Fortran?">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran" rel="up" title="Calling FFTW from Legacy Fortran">
+<link href="Upgrading-from-FFTW-version-2.html#Upgrading-from-FFTW-version-2" rel="next" title="Upgrading from FFTW version 2">
+<link href="Fortran-Examples.html#Fortran-Examples" rel="prev" title="Fortran Examples">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: initial; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
+</head>
+
+<body lang="en">
+<a name="Wisdom-of-Fortran_003f"></a>
+<div class="header">
+<p>
+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>
+</div>
+<hr>
+<a name="Wisdom-of-Fortran_003f-1"></a>
+<h3 class="section">8.5 Wisdom of Fortran?</h3>
+
+<p>In this section, we discuss how one can import/export FFTW wisdom
+(saved plans) to/from a Fortran program; we assume that the reader is
+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>.
+</p>
+<a name="index-portability-8"></a>
+<p>The basic problem is that is difficult to (portably) pass files and
+strings between Fortran and C, so we cannot provide a direct Fortran
+equivalent to the <code>fftw_export_wisdom_to_file</code>, etcetera,
+functions.  Fortran interfaces <em>are</em> provided for the functions
+that do not take file/string arguments, however:
+<code>dfftw_import_system_wisdom</code>, <code>dfftw_import_wisdom</code>,
+<code>dfftw_export_wisdom</code>, and <code>dfftw_forget_wisdom</code>.
+<a name="index-dfftw_005fimport_005fsystem_005fwisdom"></a>
+<a name="index-dfftw_005fimport_005fwisdom"></a>
+<a name="index-dfftw_005fexport_005fwisdom"></a>
+<a name="index-dfftw_005fforget_005fwisdom"></a>
+</p>
+
+<p>So, for example, to import the system-wide wisdom, you would do:
+</p>
+<div class="example">
+<pre class="example">        integer isuccess
+        call dfftw_import_system_wisdom(isuccess)
+</pre></div>
+
+<p>As usual, the C return value is turned into a first parameter;
+<code>isuccess</code> is non-zero on success and zero on failure (e.g. if
+there is no system wisdom installed).
+</p>
+<p>If you want to import/export wisdom from/to an arbitrary file or
+elsewhere, you can employ the generic <code>dfftw_import_wisdom</code> and
+<code>dfftw_export_wisdom</code> functions, for which you must supply a
+subroutine to read/write one character at a time.  The FFTW package
+contains an example file <code>doc/f77_wisdom.f</code> demonstrating how to
+implement <code>import_wisdom_from_file</code> and
+<code>export_wisdom_to_file</code> subroutines in this way.  (These routines
+cannot be compiled into the FFTW library itself, lest all FFTW-using
+programs be required to link with the Fortran I/O library.)
+</p>
+
+
+</body>
+</html>