summaryrefslogtreecommitdiff
path: root/SRC/cgerqf.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/cgerqf.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/cgerqf.f')
-rw-r--r--SRC/cgerqf.f73
1 files changed, 50 insertions, 23 deletions
diff --git a/SRC/cgerqf.f b/SRC/cgerqf.f
index a340caaa..1c9e934d 100644
--- a/SRC/cgerqf.f
+++ b/SRC/cgerqf.f
@@ -51,37 +51,42 @@
*> The number of columns 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 complexGEcomputational
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[in,out] A
*> \verbatim
-* reflectors (see Further Details).
+*> A is COMPLEX array, dimension (LDA,N)
+*> On entry, the M-by-N matrix A.
+*> On exit,
+*> if m <= n, the upper triangle of the subarray
+*> A(1:m,n-m+1:n) contains the M-by-M upper triangular matrix R;
+*> if m >= n, the elements on and above the (m-n)-th subdiagonal
+*> contain the M-by-N upper trapezoidal matrix R;
+*> the remaining elements, with the array TAU, represent the
+*> unitary matrix Q as a product of min(m,n) 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,M).
+*> \endverbatim
*>
-*> TAU (output) COMPLEX array, dimension (min(M,N))
+*> \param[out] TAU
+*> \verbatim
+*> TAU is COMPLEX array, dimension (min(M,N))
*> The scalar factors of the elementary reflectors (see Further
*> Details).
+*> \endverbatim
*>
-*> WORK (workspace/output) COMPLEX array, dimension (MAX(1,LWORK))
+*> \param[out] WORK
+*> \verbatim
+*> WORK is COMPLEX 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,M).
*> For optimum performance LWORK >= M*NB, where NB is
*> the optimal blocksize.
@@ -90,11 +95,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 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 complexGEcomputational
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The matrix Q is represented as a product of elementary reflectors
*>