Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Overview-of-Fortran-interface.html @ 82:d0c2a83c1364

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
date Tue, 19 Nov 2019 14:52:55 +0000
parents
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: Overview of Fortran interface</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Overview of Fortran interface">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Overview of Fortran interface">
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-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="up" title="Calling FFTW from Modern Fortran">
Chris@82 37 <link href="Extended-and-quadruple-precision-in-Fortran.html#Extended-and-quadruple-precision-in-Fortran" rel="next" title="Extended and quadruple precision in Fortran">
Chris@82 38 <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="prev" title="Calling FFTW from Modern Fortran">
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="Overview-of-Fortran-interface"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 Next: <a href="Reversing-array-dimensions.html#Reversing-array-dimensions" accesskey="n" rel="next">Reversing array dimensions</a>, Previous: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="p" rel="prev">Calling FFTW from Modern Fortran</a>, Up: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="u" rel="up">Calling FFTW from Modern 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="Overview-of-Fortran-interface-1"></a>
Chris@82 78 <h3 class="section">7.1 Overview of Fortran interface</h3>
Chris@82 79
Chris@82 80 <p>FFTW provides a file <code>fftw3.f03</code> that defines Fortran 2003
Chris@82 81 interfaces for all of its C routines, except for the MPI routines
Chris@82 82 described elsewhere, which can be found in the same directory as
Chris@82 83 <code>fftw3.h</code> (the C header file). In any Fortran subroutine where
Chris@82 84 you want to use FFTW functions, you should begin with:
Chris@82 85 </p>
Chris@82 86 <a name="index-iso_005fc_005fbinding-1"></a>
Chris@82 87 <div class="example">
Chris@82 88 <pre class="example"> use, intrinsic :: iso_c_binding
Chris@82 89 include 'fftw3.f03'
Chris@82 90 </pre></div>
Chris@82 91
Chris@82 92 <p>This includes the interface definitions and the standard
Chris@82 93 <code>iso_c_binding</code> module (which defines the equivalents of C
Chris@82 94 types). You can also put the FFTW functions into a module if you
Chris@82 95 prefer (see <a href="Defining-an-FFTW-module.html#Defining-an-FFTW-module">Defining an FFTW module</a>).
Chris@82 96 </p>
Chris@82 97 <p>At this point, you can now call anything in the FFTW C interface
Chris@82 98 directly, almost exactly as in C other than minor changes in syntax.
Chris@82 99 For example:
Chris@82 100 </p>
Chris@82 101 <a name="index-fftw_005fplan_005fdft_005f2d-2"></a>
Chris@82 102 <a name="index-fftw_005fexecute_005fdft-2"></a>
Chris@82 103 <a name="index-fftw_005fdestroy_005fplan-3"></a>
Chris@82 104 <div class="example">
Chris@82 105 <pre class="example"> type(C_PTR) :: plan
Chris@82 106 complex(C_DOUBLE_COMPLEX), dimension(1024,1000) :: in, out
Chris@82 107 plan = fftw_plan_dft_2d(1000,1024, in,out, FFTW_FORWARD,FFTW_ESTIMATE)
Chris@82 108 ...
Chris@82 109 call fftw_execute_dft(plan, in, out)
Chris@82 110 ...
Chris@82 111 call fftw_destroy_plan(plan)
Chris@82 112 </pre></div>
Chris@82 113
Chris@82 114 <p>A few important things to keep in mind are:
Chris@82 115 </p>
Chris@82 116 <ul>
Chris@82 117 <li> <a name="index-fftw_005fcomplex-2"></a>
Chris@82 118 <a name="index-C_005fPTR"></a>
Chris@82 119 <a name="index-C_005fINT"></a>
Chris@82 120 <a name="index-C_005fDOUBLE"></a>
Chris@82 121 <a name="index-C_005fDOUBLE_005fCOMPLEX"></a>
Chris@82 122 FFTW plans are <code>type(C_PTR)</code>. Other C types are mapped in the
Chris@82 123 obvious way via the <code>iso_c_binding</code> standard: <code>int</code> turns
Chris@82 124 into <code>integer(C_INT)</code>, <code>fftw_complex</code> turns into
Chris@82 125 <code>complex(C_DOUBLE_COMPLEX)</code>, <code>double</code> turns into
Chris@82 126 <code>real(C_DOUBLE)</code>, and so on. See <a href="FFTW-Fortran-type-reference.html#FFTW-Fortran-type-reference">FFTW Fortran type reference</a>.
Chris@82 127
Chris@82 128 </li><li> Functions in C become functions in Fortran if they have a return value,
Chris@82 129 and subroutines in Fortran otherwise.
Chris@82 130
Chris@82 131 </li><li> The ordering of the Fortran array dimensions must be <em>reversed</em>
Chris@82 132 when they are passed to the FFTW plan creation, thanks to differences
Chris@82 133 in array indexing conventions (see <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>). This is <em>unlike</em> the legacy Fortran interface
Chris@82 134 (see <a href="Fortran_002dinterface-routines.html#Fortran_002dinterface-routines">Fortran-interface routines</a>), which reversed the dimensions
Chris@82 135 for you. See <a href="Reversing-array-dimensions.html#Reversing-array-dimensions">Reversing array dimensions</a>.
Chris@82 136
Chris@82 137 </li><li> <a name="index-alignment-4"></a>
Chris@82 138 <a name="index-SIMD-2"></a>
Chris@82 139 Using ordinary Fortran array declarations like this works, but may
Chris@82 140 yield suboptimal performance because the data may not be not aligned
Chris@82 141 to exploit SIMD instructions on modern proessors (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Better performance will often be obtained
Chris@82 142 by allocating with &lsquo;<samp>fftw_alloc</samp>&rsquo;. See <a href="Allocating-aligned-memory-in-Fortran.html#Allocating-aligned-memory-in-Fortran">Allocating aligned memory in Fortran</a>.
Chris@82 143
Chris@82 144 </li><li> <a name="index-fftw_005fexecute-5"></a>
Chris@82 145 Similar to the legacy Fortran interface (see <a href="FFTW-Execution-in-Fortran.html#FFTW-Execution-in-Fortran">FFTW Execution in Fortran</a>), we currently recommend <em>not</em> using <code>fftw_execute</code>
Chris@82 146 but rather using the more specialized functions like
Chris@82 147 <code>fftw_execute_dft</code> (see <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>).
Chris@82 148 However, you should execute the plan on the <code>same arrays</code> as the
Chris@82 149 ones for which you created the plan, unless you are especially
Chris@82 150 careful. See <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran">Plan execution in Fortran</a>. To prevent
Chris@82 151 you from using <code>fftw_execute</code> by mistake, the <code>fftw3.f03</code>
Chris@82 152 file does not provide an <code>fftw_execute</code> interface declaration.
Chris@82 153
Chris@82 154 </li><li> <a name="index-flags-8"></a>
Chris@82 155 Multiple planner flags are combined with <code>ior</code> (equivalent to &lsquo;<samp>|</samp>&rsquo; in C). e.g. <code>FFTW_MEASURE | FFTW_DESTROY_INPUT</code> becomes <code>ior(FFTW_MEASURE, FFTW_DESTROY_INPUT)</code>. (You can also use &lsquo;<samp>+</samp>&rsquo; as long as you don&rsquo;t try to include a given flag more than once.)
Chris@82 156
Chris@82 157 </li></ul>
Chris@82 158
Chris@82 159 <table class="menu" border="0" cellspacing="0">
Chris@82 160 <tr><td align="left" valign="top">&bull; <a href="Extended-and-quadruple-precision-in-Fortran.html#Extended-and-quadruple-precision-in-Fortran" accesskey="1">Extended and quadruple precision in Fortran</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
Chris@82 161 </td></tr>
Chris@82 162 </table>
Chris@82 163
Chris@82 164 <hr>
Chris@82 165 <div class="header">
Chris@82 166 <p>
Chris@82 167 Next: <a href="Reversing-array-dimensions.html#Reversing-array-dimensions" accesskey="n" rel="next">Reversing array dimensions</a>, Previous: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="p" rel="prev">Calling FFTW from Modern Fortran</a>, Up: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="u" rel="up">Calling FFTW from Modern 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 168 </div>
Chris@82 169
Chris@82 170
Chris@82 171
Chris@82 172 </body>
Chris@82 173 </html>