Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Wisdom-File-Export_002fImport-from-Fortran.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: Wisdom File Export/Import from Fortran</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Wisdom File Export/Import from Fortran">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Wisdom File Export/Import from 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="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="up" title="Accessing the wisdom API from Fortran">
Chris@82 37 <link href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" rel="next" title="Wisdom String Export/Import from Fortran">
Chris@82 38 <link href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="prev" title="Accessing the wisdom API from 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="Wisdom-File-Export_002fImport-from-Fortran"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 Next: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="n" rel="next">Wisdom String Export/Import from Fortran</a>, Previous: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="p" rel="prev">Accessing the wisdom API from Fortran</a>, Up: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="u" rel="up">Accessing the wisdom API from 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-File-Export_002fImport-from-Fortran-1"></a>
Chris@82 78 <h4 class="subsection">7.6.1 Wisdom File Export/Import from Fortran</h4>
Chris@82 79
Chris@82 80 <a name="index-fftw_005fimport-wisdom_005ffrom_005ffilename"></a>
Chris@82 81 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-2"></a>
Chris@82 82 <p>The easiest way to export and import wisdom is to do so using
Chris@82 83 <code>fftw_export_wisdom_to_filename</code> and
Chris@82 84 <code>fftw_wisdom_from_filename</code>. The only trick is that these
Chris@82 85 require you to pass a C string, which is an array of type
Chris@82 86 <code>CHARACTER(C_CHAR)</code> that is terminated by <code>C_NULL_CHAR</code>.
Chris@82 87 You can call them like this:
Chris@82 88 </p>
Chris@82 89 <div class="example">
Chris@82 90 <pre class="example"> integer(C_INT) :: ret
Chris@82 91 ret = fftw_export_wisdom_to_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@82 92 if (ret .eq. 0) stop 'error exporting wisdom to file'
Chris@82 93 ret = fftw_import_wisdom_from_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@82 94 if (ret .eq. 0) stop 'error importing wisdom from file'
Chris@82 95 </pre></div>
Chris@82 96
Chris@82 97 <p>Note that prepending &lsquo;<samp>C_CHAR_</samp>&rsquo; is needed to specify that the
Chris@82 98 literal string is of kind <code>C_CHAR</code>, and we null-terminate the
Chris@82 99 string by appending &lsquo;<samp>// C_NULL_CHAR</samp>&rsquo;. These functions return an
Chris@82 100 <code>integer(C_INT)</code> (<code>ret</code>) which is <code>0</code> if an error
Chris@82 101 occurred during export/import and nonzero otherwise.
Chris@82 102 </p>
Chris@82 103 <p>It is also possible to use the lower-level routines
Chris@82 104 <code>fftw_export_wisdom_to_file</code> and
Chris@82 105 <code>fftw_import_wisdom_from_file</code>, which accept parameters of the C
Chris@82 106 type <code>FILE*</code>, expressed in Fortran as <code>type(C_PTR)</code>.
Chris@82 107 However, you are then responsible for creating the <code>FILE*</code>
Chris@82 108 yourself. You can do this by using <code>iso_c_binding</code> to define
Chris@82 109 Fortran intefaces for the C library functions <code>fopen</code> and
Chris@82 110 <code>fclose</code>, which is a bit strange in Fortran but workable.
Chris@82 111 </p>
Chris@82 112
Chris@82 113
Chris@82 114
Chris@82 115 </body>
Chris@82 116 </html>