next up previous contents index
Next: Optional Arguments Up: Design and Documentation of Previous: Order of Arguments   Contents   Index


Argument Descriptions

The style of the argument descriptions is illustrated by the following example from LA_GESV:
A
(input/output) REAL or COMPLEX square array, shape (:,:).
On entry, the matrix $A$.
On exit, the factors $L$ and $U$ from the factorization $A=P L U$; the unit diagonal elements of $L$ are not stored.
B
(input/output) REAL or COMPLEX array, shape (:,:) with $size({\bf B},1)$ = $size({\bf A},1)$ or shape $(:)$ with $size({\bf B})=size({\bf A},1)$.
On entry, the matrix $B$.
On exit, the solution matrix $X$.
IPIV
Optional (output) INTEGER array, shape $(:)$ with $size({\bf IPIV})=size({\bf A},1)$.
The pivot indices that define the permutation matrix $P$; row $i$ of the matrix was interchanged with row ${\bf IPIV}_i\:$.
INFO
Optional (output) INTEGER

\begin{infoarg}
\item[{$= 0$}]: successful exit.
\item[{$< 0$}]: if ${\bf INFO...
...he factor $U$ is singular, so the solution could not be computed.
\end{infoarg}
If ${\bf INFO}$ is not present and an error occurs, then the program is terminated with an error message.
The description of each argument gives:

next up previous contents index
Next: Optional Arguments Up: Design and Documentation of Previous: Order of Arguments   Contents   Index
Susan Blackford 2001-08-19