Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Wisdom-String-Export_002fImport-from-Fortran.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
126:4a7071416412 127:7867fa7e1b6b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <!-- This manual is for FFTW
4 (version 3.3.5, 30 July 2016).
5
6 Copyright (C) 2003 Matteo Frigo.
7
8 Copyright (C) 2003 Massachusetts Institute of Technology.
9
10 Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
13
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
18
19 Permission is granted to copy and distribute translations of this manual
20 into another language, under the above conditions for modified versions,
21 except that this permission notice may be stated in a translation
22 approved by the Free Software Foundation. -->
23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.5: Wisdom String Export/Import from Fortran</title>
26
27 <meta name="description" content="FFTW 3.3.5: Wisdom String Export/Import from Fortran">
28 <meta name="keywords" content="FFTW 3.3.5: Wisdom String Export/Import from Fortran">
29 <meta name="resource-type" content="document">
30 <meta name="distribution" content="global">
31 <meta name="Generator" content="makeinfo">
32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
33 <link href="index.html#Top" rel="start" title="Top">
34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
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">
37 <link href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran" rel="next" title="Wisdom Generic Export/Import from Fortran">
38 <link href="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran" rel="prev" title="Wisdom File Export/Import from Fortran">
39 <style type="text/css">
40 <!--
41 a.summary-letter {text-decoration: none}
42 blockquote.smallquotation {font-size: smaller}
43 div.display {margin-left: 3.2em}
44 div.example {margin-left: 3.2em}
45 div.indentedblock {margin-left: 3.2em}
46 div.lisp {margin-left: 3.2em}
47 div.smalldisplay {margin-left: 3.2em}
48 div.smallexample {margin-left: 3.2em}
49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
50 div.smalllisp {margin-left: 3.2em}
51 kbd {font-style:oblique}
52 pre.display {font-family: inherit}
53 pre.format {font-family: inherit}
54 pre.menu-comment {font-family: serif}
55 pre.menu-preformatted {font-family: serif}
56 pre.smalldisplay {font-family: inherit; font-size: smaller}
57 pre.smallexample {font-size: smaller}
58 pre.smallformat {font-family: inherit; font-size: smaller}
59 pre.smalllisp {font-size: smaller}
60 span.nocodebreak {white-space:nowrap}
61 span.nolinebreak {white-space:nowrap}
62 span.roman {font-family:serif; font-weight:normal}
63 span.sansserif {font-family:sans-serif; font-weight:normal}
64 ul.no-bullet {list-style: none}
65 -->
66 </style>
67
68
69 </head>
70
71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
72 <a name="Wisdom-String-Export_002fImport-from-Fortran"></a>
73 <div class="header">
74 <p>
75 Next: <a href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran" accesskey="n" rel="next">Wisdom Generic Export/Import from Fortran</a>, Previous: <a href="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran" accesskey="p" rel="prev">Wisdom File Export/Import 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>
76 </div>
77 <hr>
78 <a name="Wisdom-String-Export_002fImport-from-Fortran-1"></a>
79 <h4 class="subsection">7.6.2 Wisdom String Export/Import from Fortran</h4>
80
81 <a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-1"></a>
82 <p>Dealing with FFTW&rsquo;s C string export/import is a bit more painful. In
83 particular, the <code>fftw_export_wisdom_to_string</code> function requires
84 you to deal with a dynamically allocated C string. To get its length,
85 you must define an interface to the C <code>strlen</code> function, and to
86 deallocate it you must define an interface to C <code>free</code>:
87 </p>
88 <div class="example">
89 <pre class="example"> use, intrinsic :: iso_c_binding
90 interface
91 integer(C_INT) function strlen(s) bind(C, name='strlen')
92 import
93 type(C_PTR), value :: s
94 end function strlen
95 subroutine free(p) bind(C, name='free')
96 import
97 type(C_PTR), value :: p
98 end subroutine free
99 end interface
100 </pre></div>
101
102 <p>Given these definitions, you can then export wisdom to a Fortran
103 character array:
104 </p>
105 <div class="example">
106 <pre class="example"> character(C_CHAR), pointer :: s(:)
107 integer(C_SIZE_T) :: slen
108 type(C_PTR) :: p
109 p = fftw_export_wisdom_to_string()
110 if (.not. c_associated(p)) stop 'error exporting wisdom'
111 slen = strlen(p)
112 call c_f_pointer(p, s, [slen+1])
113 ...
114 call free(p)
115 </pre></div>
116 <a name="index-c_005fassociated"></a>
117 <a name="index-c_005ff_005fpointer-3"></a>
118
119 <p>Note that <code>slen</code> is the length of the C string, but the length of
120 the array is <code>slen+1</code> because it includes the terminating null
121 character. (You can omit the &lsquo;<samp>+1</samp>&rsquo; if you don&rsquo;t want Fortran to
122 know about the null character.) The standard <code>c_associated</code> function
123 checks whether <code>p</code> is a null pointer, which is returned by
124 <code>fftw_export_wisdom_to_string</code> if there was an error.
125 </p>
126 <a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring-1"></a>
127 <p>To import wisdom from a string, use
128 <code>fftw_import_wisdom_from_string</code> as usual; note that the argument
129 of this function must be a <code>character(C_CHAR)</code> that is terminated
130 by the <code>C_NULL_CHAR</code> character, like the <code>s</code> array above.
131 </p>
132
133
134
135 </body>
136 </html>