2
api-fortran95.xml: "The Specialized Fortran 95 API for PLplot" chapter
4
Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun
5
Copyright (C) 1999, 2000, 2001, 2002, 2003 Rafael Laboissiere
6
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Alan W. Irwin
7
Copyright (C) 2003 Joao Cardoso
8
Copyright (C) 2004 Andrew Ross
10
Redistribution and use in source (XML DocBook) and "compiled" forms
11
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
12
modification, are permitted provided that the following conditions are
15
1. Redistributions of source code (XML DocBook) must retain the
16
above copyright notice, this list of conditions and the following
17
disclaimer as the first lines of this file unmodified.
19
2. Redistributions in compiled form (transformed to other DTDs,
20
converted to HTML, PDF, PostScript, and other formats) must
21
reproduce the above copyright notice, this list of conditions and
22
the following disclaimer in the documentation and/or other
23
materials provided with the distribution.
25
Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
26
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
29
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
35
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
<chapter id="API-FORTRAN-95">
39
<title>The Specialized Fortran 95 API for PLplot</title>
42
The purpose of this Chapter is to document the API for each Fortran 95 function
43
in PLplot that differs substantially (usually in argument lists)
44
from the common API that has already been
45
documented in <xref linkend="API"/>.
49
Normally, the common API is wrapped in such a way for Fortran 95 that there is
50
and one-to-one correspondence between each Fortran 95 and C argument
51
(see <xref linkend="fortran95"/>
52
for discussion). However, for certain routines documented in this
53
chapter the Fortran 95 argument lists
54
necessarily differ substantially from the C versions.
58
This chapter is incomplete and NEEDS DOCUMENTATION.
61
<sect1 id="plcontfortran95" renderas="sect3">
63
<function>plcont</function>: Contour plot for Fortran 95
67
This is an overloaded function with a variety of argument lists
68
which NEED DOCUMENTATION.
72
When called from Fortran 95, this overloaded routine has the same
73
effect as when invoked from C. See
74
<filename>examples/f95/x??f.f90</filename> for various ways to call
75
plcont from Fortran 95.
80
<sect1 id="plshadefortran95" renderas="sect3">
82
<function>plshade</function>: Shaded plot for Fortran 95
86
This is an overloaded function with a variety of argument lists
87
which NEED DOCUMENTATION.
91
When called from Fortran 95, this overloaded routine has the same
92
effect as when invoked from C. See
93
<filename>examples/f95/x??f.f90</filename> for various ways to call
94
plshade from Fortran 95.
99
<sect1 id="plshadesfortran95" renderas="sect3">
101
<function>plshades</function>: Continuously shaded plot for Fortran 95
105
This is an overloaded function with a variety of argument lists
106
which NEED DOCUMENTATION.
110
When called from Fortran 95, this overloaded routine has the same
111
effect as when invoked from C. See
112
<filename>examples/f95/x??f.f90</filename> for various ways to call
113
plshades from Fortran 95.
118
<sect1 id="plvectfortran95" renderas="sect3">
120
<function>plvect</function>: Vector plot for Fortran 95
124
This is an overloaded function with a variety of argument lists
125
which NEED DOCUMENTATION.
129
When called from Fortran 95, this overloaded routine has the same
130
effect as when invoked from C. See
131
<filename>examples/f95/x??f.f90</filename> for various ways to call
132
plvect from Fortran 95.
137
<sect1 id="plmeshfortran95" renderas="sect3">
139
<function>plmesh</function>: Plot surface mesh for Fortran 95
146
<function>plmesh</function>
148
<paramdef><parameter>x</parameter></paramdef>
149
<paramdef><parameter>y</parameter></paramdef>
150
<paramdef><parameter>z</parameter></paramdef>
151
<paramdef><parameter>nx</parameter></paramdef>
152
<paramdef><parameter>ny</parameter></paramdef>
153
<paramdef><parameter>opt</parameter></paramdef>
154
<paramdef><parameter>mx</parameter></paramdef>
160
When called from Fortran 95, this routine has the same effect as when
161
invoked from C. The interpretation of all parameters (see &plmesh;)
162
is also the same except there is an additional parameter given by:
168
<parameter>mx</parameter>
169
(<literal>PLINT</literal>, input)
173
Length of array in x direction, for plotting subarrays.
181
<sect1 id="plot3dfortran95" renderas="sect3">
183
<function>plot3d</function>: Plot 3-d surface plot for Fortran 95
190
<function>plot3d</function>
192
<paramdef><parameter>x</parameter></paramdef>
193
<paramdef><parameter>y</parameter></paramdef>
194
<paramdef><parameter>z</parameter></paramdef>
195
<paramdef><parameter>nx</parameter></paramdef>
196
<paramdef><parameter>ny</parameter></paramdef>
197
<paramdef><parameter>opt</parameter></paramdef>
198
<paramdef><parameter>side</parameter></paramdef>
199
<paramdef><parameter>mx</parameter></paramdef>
205
When called from Fortran 95, this routine has the same effect as when
206
invoked from C. The interpretation of all parameters (see &plot3d;)
207
is also the same except there is an additional parameter given by:
213
<parameter>mx</parameter>
214
(<literal>PLINT</literal>, input)
218
Length of array in x direction, for plotting subarrays.
226
<sect1 id="plparseoptsfortran95" renderas="sect3">
228
<function>plparseopts</function>: parse arguments for Fortran 95
235
<function>plparseopts</function>
237
<paramdef><parameter>mode</parameter></paramdef>
242
<para> When called from Fortran 95, this routine has the same effect as
243
when invoked from C (see &plparseopts;) except that the argument list
244
just contains the parsing mode and the Fortran 95 system routines
245
<function>iargc</function> and <function>getarg</function>
246
are used internally to obtain the number of arguments and
247
argument values. (Note, during configuration, the user's
249
is checked to see whether it supports
250
<function>iargc</function> and <function>getarg</function>. If it
251
does not, the Fortran 95 plparseopts simply writes a warning message
258
<parameter>mode</parameter>
259
(<literal>PLINT</literal>, input)
263
Parsing mode; see &plparseopts; for details.
271
<sect1 id="plsescfortran95" renderas="sect3">
273
<function>plsesc</function>: Set the escape character for text strings
281
<function>plsesc</function>
283
<paramdef><parameter>esc</parameter></paramdef>
289
Set the escape character for text strings. From
290
Fortran 95 it needs to be the decimal ASCII value. Only
291
selected characters are allowed to prevent the user from shooting
292
himself in the foot (For example, a <quote>\</quote> isn't allowed since it conflicts with C's use
293
of backslash as a character escape). Here are the allowed escape
294
characters and their corresponding decimal ASCII values:
298
<quote>!</quote>, ASCII 33
303
<quote>#</quote>, ASCII 35
308
<quote>$</quote>, ASCII 36
313
<quote>%</quote>, ASCII 37
318
<quote>&</quote>, ASCII 38
323
<quote>*</quote>, ASCII 42
328
<quote>@</quote>, ASCII 64
333
<quote>^</quote>, ASCII 94
338
<quote>~</quote>, ASCII 126
347
<parameter>esc</parameter>
348
(<literal>char</literal>, input)
362
<!-- Keep this comment at the end of the file
367
sgml-minimize-attributes:nil
368
sgml-always-quote-attributes:t
371
sgml-parent-document: ("plplotdoc.xml" "book" "chapter" "")
372
sgml-default-dtd-file:nil
373
sgml-exposed-tags:nil
374
sgml-local-catalogs:("/usr/lib/sgml/catalog")
375
sgml-local-ecat-files:nil
added
removed
doc/docbook/src/api-fortran95.xml
