1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 98.2 beta6 (August 14th, 1998)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Argument Descriptions</TITLE>
<META NAME="description" CONTENT="Argument Descriptions">
<META NAME="keywords" CONTENT="lug_l2h">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="lug_l2h.css">
<LINK REL="next" HREF="node114.html">
<LINK REL="previous" HREF="node112.html">
<LINK REL="up" HREF="node110.html">
<LINK REL="next" HREF="node114.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html5803"
HREF="node114.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
SRC="next_motif.png"></A>
<A NAME="tex2html5797"
HREF="node110.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
SRC="up_motif.png"></A>
<A NAME="tex2html5791"
HREF="node112.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
SRC="previous_motif.png"></A>
<A NAME="tex2html5799"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
SRC="contents_motif.png"></A>
<A NAME="tex2html5801"
HREF="node152.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
SRC="index_motif.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html5804"
HREF="node114.html">Option Arguments</A>
<B> Up:</B> <A NAME="tex2html5798"
HREF="node110.html">Design and Documentation of</A>
<B> Previous:</B> <A NAME="tex2html5792"
HREF="node112.html">Order of Arguments</A>
  <B> <A NAME="tex2html5800"
HREF="node1.html">Contents</A></B>
  <B> <A NAME="tex2html5802"
HREF="node152.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION03513000000000000000"></A><A NAME="subsecargdesc"></A>
<BR>
Argument Descriptions
</H2>
<P>
The style of the argument<A NAME="19467"></A>
descriptions is illustrated by the following example:
<P>
<DIV ALIGN="CENTER">
</DIV><TABLE WIDTH="547">
<TR><TD>
<DT>N
<DL COMPACT><DD>(input) INTEGER
<BR>
The number of columns of the matrix A. N <IMG
WIDTH="18" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img913.png"
ALT="$\geq$">
0.
<P>
<DT>A
<DD>(input/output) REAL array, dimension (LDA,N)
<BR>
On entry, the m-by-n matrix to be factored.
<BR>
On exit, the factors L and U from the factorization
A = P<IMG
WIDTH="13" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img914.png"
ALT="$\ast$">L<IMG
WIDTH="13" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img914.png"
ALT="$\ast$">U; the unit diagonal elements of L are not stored.
</DL>
</TD></TR>
</TABLE>
<DIV ALIGN="CENTER">
</DIV>
<P>
The description of each argument gives:
<P>
<UL><LI>a classification of the argument as (input), (output),
(input/output), (input or output)<A NAME="tex2html2527"
HREF="footnode.html#foot19489"><SUP>5.1</SUP></A>,
(workspace) or (workspace/output)<A NAME="tex2html2528"
HREF="footnode.html#foot19490"><SUP>5.2</SUP></A>;
<P>
<LI>the type of the argument;
<P>
<LI>(for an array) its dimension(s);
<P>
<LI>a specification of the value(s) that must be supplied for the
argument (if it's an input argument), or of the value(s) returned
by the routine (if it's an output argument), or both (if it's an
input/output argument). In the last case, the two parts of the
description are introduced by the phrases ``On entry'' and
``On exit''.
<P>
<LI>(for a scalar input argument) any constraints that the
supplied values must satisfy (such as ``N <IMG
WIDTH="18" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img913.png"
ALT="$\geq$">
0'' in the
example above).
<P>
</UL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html5803"
HREF="node114.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
SRC="next_motif.png"></A>
<A NAME="tex2html5797"
HREF="node110.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
SRC="up_motif.png"></A>
<A NAME="tex2html5791"
HREF="node112.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
SRC="previous_motif.png"></A>
<A NAME="tex2html5799"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
SRC="contents_motif.png"></A>
<A NAME="tex2html5801"
HREF="node152.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
SRC="index_motif.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html5804"
HREF="node114.html">Option Arguments</A>
<B> Up:</B> <A NAME="tex2html5798"
HREF="node110.html">Design and Documentation of</A>
<B> Previous:</B> <A NAME="tex2html5792"
HREF="node112.html">Order of Arguments</A>
  <B> <A NAME="tex2html5800"
HREF="node1.html">Contents</A></B>
  <B> <A NAME="tex2html5802"
HREF="node152.html">Index</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
<I>Susan Blackford</I>
<BR><I>1999-10-01</I>
</ADDRESS>
</BODY>
</HTML>
|
