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
|
<!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>Structure of the Documentation</TITLE>
<META NAME="description" CONTENT="Structure of the Documentation">
<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="node112.html">
<LINK REL="previous" HREF="node110.html">
<LINK REL="up" HREF="node110.html">
<LINK REL="next" HREF="node112.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html5775"
HREF="node112.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
SRC="next_motif.png"></A>
<A NAME="tex2html5769"
HREF="node110.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
SRC="up_motif.png"></A>
<A NAME="tex2html5763"
HREF="node110.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
SRC="previous_motif.png"></A>
<A NAME="tex2html5771"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
SRC="contents_motif.png"></A>
<A NAME="tex2html5773"
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="tex2html5776"
HREF="node112.html">Order of Arguments</A>
<B> Up:</B> <A NAME="tex2html5770"
HREF="node110.html">Design and Documentation of</A>
<B> Previous:</B> <A NAME="tex2html5764"
HREF="node110.html">Design and Documentation of</A>
  <B> <A NAME="tex2html5772"
HREF="node1.html">Contents</A></B>
  <B> <A NAME="tex2html5774"
HREF="node152.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION03511000000000000000"></A><A NAME="subsecstructdoc"></A>
<BR>
Structure of the Documentation
</H2>
<P>
The documentation<A NAME="19451"></A> of each LAPACK
routine includes:
<P>
<UL><LI>the SUBROUTINE or FUNCTION statement, followed by statements
declaring the type and dimensions of the arguments;
<P>
<LI>a summary of the <B>Purpose</B> of the routine;
<P>
<LI>descriptions of each of the <B>Arguments</B> in the order of
the argument list;
<P>
<LI>(optionally) <B>Further Details</B>
(only in the code, not in Part <A HREF="node149.html#partroutines">2</A>);
<P>
<LI>(optionally) <B>Internal Parameters</B>
(only in the code, not in Part <A HREF="node149.html#partroutines">2</A>).
<P>
</UL>
<P>
<BR><HR>
<ADDRESS>
<I>Susan Blackford</I>
<BR><I>1999-10-01</I>
</ADDRESS>
</BODY>
</HTML>
|