Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.3/doc/html/Wisdom-String-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 String 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="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran" title="Wisdom File Export/Import from Fortran">
10 <link rel="next" href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran" title="Wisdom Generic 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-String-Export%2fImport-from-Fortran"></a>
50 <a name="Wisdom-String-Export_002fImport-from-Fortran"></a>
51 <p>
52 Next:&nbsp;<a rel="next" accesskey="n" href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran">Wisdom Generic Export/Import from Fortran</a>,
53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran">Wisdom File Export/Import 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.2 Wisdom String Export/Import from Fortran</h4>
59
60 <p><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-568"></a>Dealing with FFTW's C string export/import is a bit more painful. In
61 particular, the <code>fftw_export_wisdom_to_string</code> function requires
62 you to deal with a dynamically allocated C string. To get its length,
63 you must define an interface to the C <code>strlen</code> function, and to
64 deallocate it you must define an interface to C <code>free</code>:
65
66 <pre class="example"> use, intrinsic :: iso_c_binding
67 interface
68 integer(C_INT) function strlen(s) bind(C, name='strlen')
69 import
70 type(C_PTR), value :: s
71 end function strlen
72 subroutine free(p) bind(C, name='free')
73 import
74 type(C_PTR), value :: p
75 end subroutine free
76 end interface
77 </pre>
78 <p>Given these definitions, you can then export wisdom to a Fortran
79 character array:
80
81 <pre class="example"> character(C_CHAR), pointer :: s(:)
82 integer(C_SIZE_T) :: slen
83 type(C_PTR) :: p
84 p = fftw_export_wisdom_to_string()
85 if (.not. c_associated(p)) stop 'error exporting wisdom'
86 slen = strlen(p)
87 call c_f_pointer(p, s, [slen+1])
88 ...
89 call free(p)
90 </pre>
91 <p><a name="index-c_005fassociated-569"></a><a name="index-c_005ff_005fpointer-570"></a>
92 Note that <code>slen</code> is the length of the C string, but the length of
93 the array is <code>slen+1</code> because it includes the terminating null
94 character. (You can omit the &lsquo;<samp><span class="samp">+1</span></samp>&rsquo; if you don't want Fortran to
95 know about the null character.) The standard <code>c_associated</code> function
96 checks whether <code>p</code> is a null pointer, which is returned by
97 <code>fftw_export_wisdom_to_string</code> if there was an error.
98
99 <p><a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring-571"></a>To import wisdom from a string, use
100 <code>fftw_import_wisdom_from_string</code> as usual; note that the argument
101 of this function must be a <code>character(C_CHAR)</code> that is terminated
102 by the <code>C_NULL_CHAR</code> character, like the <code>s</code> array above.
103
104 <!-- =========> -->
105 </body></html>
106