aboutsummaryrefslogtreecommitdiff
path: root/SRC/sgehd2.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
commit0d9e213c670ab0e68f17d68251412d53250108e1 (patch)
tree2bcab1c08b84e327b9be345385e2c31e8a26905a /SRC/sgehd2.f
parent82901cd3e7bb75c73fc3a17fe7bf922289337f97 (diff)
Correct Warning detected during Doxygen Generation.
Now each routine should have the correct list of arguments. This allowed to detect and fix problems in parameter description of many routines.
Diffstat (limited to 'SRC/sgehd2.f')
-rw-r--r--SRC/sgehd2.f75
1 files changed, 52 insertions, 23 deletions
diff --git a/SRC/sgehd2.f b/SRC/sgehd2.f
index 47902fc2..0c1a28f6 100644
--- a/SRC/sgehd2.f
+++ b/SRC/sgehd2.f
@@ -45,48 +45,77 @@
*> The order of the matrix A. N >= 0.
*> \endverbatim
*>
-*
-* Authors
-* =======
-*
-*> \author Univ. of Tennessee
-*> \author Univ. of California Berkeley
-*> \author Univ. of Colorado Denver
-*> \author NAG Ltd.
-*
-*> \date November 2011
-*
-*> \ingroup realGEcomputational
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[in] ILO
+*> \verbatim
+*> ILO is INTEGER
+*> \endverbatim
+*>
+*> \param[in] IHI
*> \verbatim
-* set to 1 and N respectively. See Further Details.
+*> IHI is INTEGER
+*> \endverbatim
+*> \verbatim
+*> It is assumed that A is already upper triangular in rows
+*> and columns 1:ILO-1 and IHI+1:N. ILO and IHI are normally
+*> set by a previous call to SGEBAL; otherwise they should be
+*> set to 1 and N respectively. See Further Details.
*> 1 <= ILO <= IHI <= max(1,N).
+*> \endverbatim
*>
-*> A (input/output) REAL array, dimension (LDA,N)
+*> \param[in,out] A
+*> \verbatim
+*> A is REAL array, dimension (LDA,N)
*> On entry, the n by n general matrix to be reduced.
*> On exit, the upper triangle and the first subdiagonal of A
*> are overwritten with the upper Hessenberg matrix H, and the
*> elements below the first subdiagonal, with the array TAU,
*> represent the orthogonal matrix Q as a product of elementary
*> reflectors. See Further Details.
+*> \endverbatim
*>
-*> LDA (input) INTEGER
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
*> The leading dimension of the array A. LDA >= max(1,N).
+*> \endverbatim
*>
-*> TAU (output) REAL array, dimension (N-1)
+*> \param[out] TAU
+*> \verbatim
+*> TAU is REAL array, dimension (N-1)
*> The scalar factors of the elementary reflectors (see Further
*> Details).
+*> \endverbatim
*>
-*> WORK (workspace) REAL array, dimension (N)
+*> \param[out] WORK
+*> \verbatim
+*> WORK is REAL array, dimension (N)
+*> \endverbatim
*>
-*> INFO (output) INTEGER
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
*> = 0: successful exit.
*> < 0: if INFO = -i, the i-th argument had an illegal value.
+*> \endverbatim
*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup realGEcomputational
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The matrix Q is represented as a product of (ihi-ilo) elementary
*> reflectors