Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.3/doc/html/Wisdom-File-Export_002fImport-from-Fortran.html @ 10:37bf6b4a2645

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