summaryrefslogtreecommitdiff
path: root/SRC/clabrd.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/clabrd.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/clabrd.f')
-rw-r--r--SRC/clabrd.f100
1 files changed, 73 insertions, 27 deletions
diff --git a/SRC/clabrd.f b/SRC/clabrd.f
index ab63b734..a1b725c8 100644
--- a/SRC/clabrd.f
+++ b/SRC/clabrd.f
@@ -67,59 +67,105 @@
*> The number of leading rows and columns of A to be reduced.
*> \endverbatim
*>
-*
-* Authors
-* =======
-*
-*> \author Univ. of Tennessee
-*> \author Univ. of California Berkeley
-*> \author Univ. of Colorado Denver
-*> \author NAG Ltd.
-*
-*> \date November 2011
-*
-*> \ingroup complexOTHERauxiliary
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[in,out] A
*> \verbatim
-* See Further Details.
+*> A is COMPLEX array, dimension (LDA,N)
+*> On entry, the m by n general matrix to be reduced.
+*> On exit, the first NB rows and columns of the matrix are
+*> overwritten; the rest of the array is unchanged.
+*> If m >= n, elements on and below the diagonal in the first NB
+*> columns, with the array TAUQ, represent the unitary
+*> matrix Q as a product of elementary reflectors; and
+*> elements above the diagonal in the first NB rows, with the
+*> array TAUP, represent the unitary matrix P as a product
+*> of elementary reflectors.
+*> If m < n, elements below the diagonal in the first NB
+*> columns, with the array TAUQ, represent the unitary
+*> matrix Q as a product of elementary reflectors, and
+*> elements on and above the diagonal in the first NB rows,
+*> with the array TAUP, represent the unitary matrix P 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,M).
+*> \endverbatim
*>
-*> D (output) REAL array, dimension (NB)
+*> \param[out] D
+*> \verbatim
+*> D is REAL array, dimension (NB)
*> The diagonal elements of the first NB rows and columns of
*> the reduced matrix. D(i) = A(i,i).
+*> \endverbatim
*>
-*> E (output) REAL array, dimension (NB)
+*> \param[out] E
+*> \verbatim
+*> E is REAL array, dimension (NB)
*> The off-diagonal elements of the first NB rows and columns of
*> the reduced matrix.
+*> \endverbatim
*>
-*> TAUQ (output) COMPLEX array dimension (NB)
+*> \param[out] TAUQ
+*> \verbatim
+*> TAUQ is COMPLEX array dimension (NB)
*> The scalar factors of the elementary reflectors which
*> represent the unitary matrix Q. See Further Details.
+*> \endverbatim
*>
-*> TAUP (output) COMPLEX array, dimension (NB)
+*> \param[out] TAUP
+*> \verbatim
+*> TAUP is COMPLEX array, dimension (NB)
*> The scalar factors of the elementary reflectors which
*> represent the unitary matrix P. See Further Details.
+*> \endverbatim
*>
-*> X (output) COMPLEX array, dimension (LDX,NB)
+*> \param[out] X
+*> \verbatim
+*> X is COMPLEX array, dimension (LDX,NB)
*> The m-by-nb matrix X required to update the unreduced part
*> of A.
+*> \endverbatim
*>
-*> LDX (input) INTEGER
+*> \param[in] LDX
+*> \verbatim
+*> LDX is INTEGER
*> The leading dimension of the array X. LDX >= max(1,M).
+*> \endverbatim
*>
-*> Y (output) COMPLEX array, dimension (LDY,NB)
+*> \param[out] Y
+*> \verbatim
+*> Y is COMPLEX array, dimension (LDY,NB)
*> The n-by-nb matrix Y required to update the unreduced part
*> of A.
+*> \endverbatim
*>
-*> LDY (input) INTEGER
+*> \param[in] LDY
+*> \verbatim
+*> LDY is INTEGER
*> The leading dimension of the array Y. LDY >= max(1,N).
+*> \endverbatim
*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup complexOTHERauxiliary
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The matrices Q and P are represented as products of elementary
*> reflectors: