summaryrefslogtreecommitdiff
path: root/SRC/dggrqf.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/dggrqf.f
parent82901cd3e7bb75c73fc3a17fe7bf922289337f97 (diff)
downloadlapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.gz
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.bz2
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.zip
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/dggrqf.f')
-rw-r--r--SRC/dggrqf.f71
1 files changed, 47 insertions, 24 deletions
diff --git a/SRC/dggrqf.f b/SRC/dggrqf.f
index 6a930a72..1d1a9a46 100644
--- a/SRC/dggrqf.f
+++ b/SRC/dggrqf.f
@@ -103,45 +103,46 @@
*> The leading dimension of the array A. LDA >= max(1,M).
*> \endverbatim
*>
-*
-* Authors
-* =======
-*
-*> \author Univ. of Tennessee
-*> \author Univ. of California Berkeley
-*> \author Univ. of Colorado Denver
-*> \author NAG Ltd.
-*
-*> \date November 2011
-*
-*> \ingroup doubleOTHERcomputational
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[out] TAUA
*> \verbatim
-* represent the orthogonal matrix Q (see Further Details).
+*> TAUA is DOUBLE PRECISION array, dimension (min(M,N))
+*> The scalar factors of the elementary reflectors which
+*> represent the orthogonal matrix Q (see Further Details).
+*> \endverbatim
*>
-*> B (input/output) DOUBLE PRECISION array, dimension (LDB,N)
+*> \param[in,out] B
+*> \verbatim
+*> B is DOUBLE PRECISION array, dimension (LDB,N)
*> On entry, the P-by-N matrix B.
*> On exit, the elements on and above the diagonal of the array
*> contain the min(P,N)-by-N upper trapezoidal matrix T (T is
*> upper triangular if P >= N); the elements below the diagonal,
*> with the array TAUB, represent the orthogonal matrix Z as a
*> product of elementary reflectors (see Further Details).
+*> \endverbatim
*>
-*> LDB (input) INTEGER
+*> \param[in] LDB
+*> \verbatim
+*> LDB is INTEGER
*> The leading dimension of the array B. LDB >= max(1,P).
+*> \endverbatim
*>
-*> TAUB (output) DOUBLE PRECISION array, dimension (min(P,N))
+*> \param[out] TAUB
+*> \verbatim
+*> TAUB is DOUBLE PRECISION array, dimension (min(P,N))
*> The scalar factors of the elementary reflectors which
*> represent the orthogonal matrix Z (see Further Details).
+*> \endverbatim
*>
-*> WORK (workspace/output) DOUBLE PRECISION array, dimension (MAX(1,LWORK))
+*> \param[out] WORK
+*> \verbatim
+*> WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK))
*> On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
+*> \endverbatim
*>
-*> LWORK (input) INTEGER
+*> \param[in] LWORK
+*> \verbatim
+*> LWORK is INTEGER
*> The dimension of the array WORK. LWORK >= max(1,N,M,P).
*> For optimum performance LWORK >= max(N,M,P)*max(NB1,NB2,NB3),
*> where NB1 is the optimal blocksize for the RQ factorization
@@ -153,11 +154,33 @@
*> only calculates the optimal size of the WORK array, returns
*> this value as the first entry of the WORK array, and no error
*> message related to LWORK is issued by XERBLA.
+*> \endverbatim
*>
-*> INFO (output) INTEGER
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
*> = 0: successful exit
*> < 0: if INF0= -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 doubleOTHERcomputational
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The matrix Q is represented as a product of elementary reflectors
*>