aboutsummaryrefslogtreecommitdiff
path: root/SRC/sgebal.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/sgebal.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/sgebal.f')
-rw-r--r--SRC/sgebal.f69
1 files changed, 45 insertions, 24 deletions
diff --git a/SRC/sgebal.f b/SRC/sgebal.f
index ca9c6edf..1f5eb377 100644
--- a/SRC/sgebal.f
+++ b/SRC/sgebal.f
@@ -64,37 +64,36 @@
*> 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,out] A
*> \verbatim
-* See Further Details.
+*> A is REAL array, dimension (LDA,N)
+*> On entry, the input matrix A.
+*> On exit, A is overwritten by the balanced matrix.
+*> If JOB = 'N', A is not referenced.
+*> 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
*>
-*> ILO (output) INTEGER
-*>
-*> IHI (output) INTEGER
+*> \param[out] ILO
+*> \verbatim
+*> ILO is INTEGER
+*> \endverbatim
+*> \param[out] IHI
+*> \verbatim
+*> IHI is INTEGER
*> ILO and IHI are set to integers such that on exit
*> A(i,j) = 0 if i > j and j = 1,...,ILO-1 or I = IHI+1,...,N.
*> If JOB = 'N' or 'S', ILO = 1 and IHI = N.
+*> \endverbatim
*>
-*> SCALE (output) REAL array, dimension (N)
+*> \param[out] SCALE
+*> \verbatim
+*> SCALE is REAL array, dimension (N)
*> Details of the permutations and scaling factors applied to
*> A. If P(j) is the index of the row and column interchanged
*> with row and column j and D(j) is the scaling factor
@@ -104,11 +103,33 @@
*> = P(j) for j = IHI+1,...,N.
*> The order in which the interchanges are made is N to IHI+1,
*> then 1 to ILO-1.
+*> \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 permutations consist of row and column interchanges which put
*> the matrix in the form