Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.3/doc/html/Wisdom-File-Export_002fImport-from-Fortran.html @ 83:ae30d91d2ffe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 37bf6b4a2645
children
rev   line source
Chris@10 1 <html lang="en">
Chris@10 2 <head>
Chris@10 3 <title>Wisdom File Export/Import from Fortran - FFTW 3.3.3</title>
Chris@10 4 <meta http-equiv="Content-Type" content="text/html">
Chris@10 5 <meta name="description" content="FFTW 3.3.3">
Chris@10 6 <meta name="generator" content="makeinfo 4.13">
Chris@10 7 <link title="Top" rel="start" href="index.html#Top">
Chris@10 8 <link rel="up" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" title="Accessing the wisdom API from Fortran">
Chris@10 9 <link rel="prev" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" title="Accessing the wisdom API from Fortran">
Chris@10 10 <link rel="next" href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" title="Wisdom String Export/Import from Fortran">
Chris@10 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@10 12 <!--
Chris@10 13 This manual is for FFTW
Chris@10 14 (version 3.3.3, 25 November 2012).
Chris@10 15
Chris@10 16 Copyright (C) 2003 Matteo Frigo.
Chris@10 17
Chris@10 18 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@10 19
Chris@10 20 Permission is granted to make and distribute verbatim copies of
Chris@10 21 this manual provided the copyright notice and this permission
Chris@10 22 notice are preserved on all copies.
Chris@10 23
Chris@10 24 Permission is granted to copy and distribute modified versions of
Chris@10 25 this manual under the conditions for verbatim copying, provided
Chris@10 26 that the entire resulting derived work is distributed under the
Chris@10 27 terms of a permission notice identical to this one.
Chris@10 28
Chris@10 29 Permission is granted to copy and distribute translations of this
Chris@10 30 manual into another language, under the above conditions for
Chris@10 31 modified versions, except that this permission notice may be
Chris@10 32 stated in a translation approved by the Free Software Foundation.
Chris@10 33 -->
Chris@10 34 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@10 35 <style type="text/css"><!--
Chris@10 36 pre.display { font-family:inherit }
Chris@10 37 pre.format { font-family:inherit }
Chris@10 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@10 39 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@10 40 pre.smallexample { font-size:smaller }
Chris@10 41 pre.smalllisp { font-size:smaller }
Chris@10 42 span.sc { font-variant:small-caps }
Chris@10 43 span.roman { font-family:serif; font-weight:normal; }
Chris@10 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@10 45 --></style>
Chris@10 46 </head>
Chris@10 47 <body>
Chris@10 48 <div class="node">
Chris@10 49 <a name="Wisdom-File-Export%2fImport-from-Fortran"></a>
Chris@10 50 <a name="Wisdom-File-Export_002fImport-from-Fortran"></a>
Chris@10 51 <p>
Chris@10 52 Next:&nbsp;<a rel="next" accesskey="n" href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran">Wisdom String Export/Import from Fortran</a>,
Chris@10 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran">Accessing the wisdom API from Fortran</a>,
Chris@10 54 Up:&nbsp;<a rel="up" accesskey="u" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran">Accessing the wisdom API from Fortran</a>
Chris@10 55 <hr>
Chris@10 56 </div>
Chris@10 57
Chris@10 58 <h4 class="subsection">7.6.1 Wisdom File Export/Import from Fortran</h4>
Chris@10 59
Chris@10 60 <p><a name="index-fftw_005fimport-wisdom_005ffrom_005ffilename-566"></a><a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-567"></a>The easiest way to export and import wisdom is to do so using
Chris@10 61 <code>fftw_export_wisdom_to_filename</code> and
Chris@10 62 <code>fftw_wisdom_from_filename</code>. The only trick is that these
Chris@10 63 require you to pass a C string, which is an array of type
Chris@10 64 <code>CHARACTER(C_CHAR)</code> that is terminated by <code>C_NULL_CHAR</code>.
Chris@10 65 You can call them like this:
Chris@10 66
Chris@10 67 <pre class="example"> integer(C_INT) :: ret
Chris@10 68 ret = fftw_export_wisdom_to_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@10 69 if (ret .eq. 0) stop 'error exporting wisdom to file'
Chris@10 70 ret = fftw_import_wisdom_from_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@10 71 if (ret .eq. 0) stop 'error importing wisdom from file'
Chris@10 72 </pre>
Chris@10 73 <p>Note that prepending &lsquo;<samp><span class="samp">C_CHAR_</span></samp>&rsquo; is needed to specify that the
Chris@10 74 literal string is of kind <code>C_CHAR</code>, and we null-terminate the
Chris@10 75 string by appending &lsquo;<samp><span class="samp">// C_NULL_CHAR</span></samp>&rsquo;. These functions return an
Chris@10 76 <code>integer(C_INT)</code> (<code>ret</code>) which is <code>0</code> if an error
Chris@10 77 occurred during export/import and nonzero otherwise.
Chris@10 78
Chris@10 79 <p>It is also possible to use the lower-level routines
Chris@10 80 <code>fftw_export_wisdom_to_file</code> and
Chris@10 81 <code>fftw_import_wisdom_from_file</code>, which accept parameters of the C
Chris@10 82 type <code>FILE*</code>, expressed in Fortran as <code>type(C_PTR)</code>.
Chris@10 83 However, you are then responsible for creating the <code>FILE*</code>
Chris@10 84 yourself. You can do this by using <code>iso_c_binding</code> to define
Chris@10 85 Fortran intefaces for the C library functions <code>fopen</code> and
Chris@10 86 <code>fclose</code>, which is a bit strange in Fortran but workable.
Chris@10 87
Chris@10 88 <!-- =========> -->
Chris@10 89 </body></html>
Chris@10 90