diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-31 22:21:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-31 22:21:11 +0000 |
commit | 0d9e213c670ab0e68f17d68251412d53250108e1 (patch) | |
tree | 2bcab1c08b84e327b9be345385e2c31e8a26905a /SRC/cgebd2.f | |
parent | 82901cd3e7bb75c73fc3a17fe7bf922289337f97 (diff) | |
download | lapack-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/cgebd2.f')
-rw-r--r-- | SRC/cgebd2.f | 92 |
1 files changed, 67 insertions, 25 deletions
diff --git a/SRC/cgebd2.f b/SRC/cgebd2.f index 1b47e91b..12453e55 100644 --- a/SRC/cgebd2.f +++ b/SRC/cgebd2.f @@ -54,52 +54,94 @@ *> The number of columns in 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 -* See Further Details. +*> A is COMPLEX array, dimension (LDA,N) +*> On entry, the m by n general matrix to be reduced. +*> On exit, +*> if m >= n, the diagonal and the first superdiagonal are +*> overwritten with the upper bidiagonal matrix B; the +*> elements below the diagonal, with the array TAUQ, represent +*> the unitary matrix Q as a product of elementary +*> reflectors, and the elements above the first superdiagonal, +*> with the array TAUP, represent the unitary matrix P as +*> a product of elementary reflectors; +*> if m < n, the diagonal and the first subdiagonal are +*> overwritten with the lower bidiagonal matrix B; the +*> elements below the first subdiagonal, with the array TAUQ, +*> represent the unitary matrix Q as a product of +*> elementary reflectors, and the elements above the diagonal, +*> 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 (min(M,N)) +*> \param[out] D +*> \verbatim +*> D is REAL array, dimension (min(M,N)) *> The diagonal elements of the bidiagonal matrix B: *> D(i) = A(i,i). +*> \endverbatim *> -*> E (output) REAL array, dimension (min(M,N)-1) +*> \param[out] E +*> \verbatim +*> E is REAL array, dimension (min(M,N)-1) *> The off-diagonal elements of the bidiagonal matrix B: *> if m >= n, E(i) = A(i,i+1) for i = 1,2,...,n-1; *> if m < n, E(i) = A(i+1,i) for i = 1,2,...,m-1. +*> \endverbatim *> -*> TAUQ (output) COMPLEX array dimension (min(M,N)) +*> \param[out] TAUQ +*> \verbatim +*> TAUQ is COMPLEX array dimension (min(M,N)) *> The scalar factors of the elementary reflectors which *> represent the unitary matrix Q. See Further Details. +*> \endverbatim *> -*> TAUP (output) COMPLEX array, dimension (min(M,N)) +*> \param[out] TAUP +*> \verbatim +*> TAUP is COMPLEX array, dimension (min(M,N)) *> The scalar factors of the elementary reflectors which *> represent the unitary matrix P. See Further Details. +*> \endverbatim *> -*> WORK (workspace) COMPLEX array, dimension (max(M,N)) +*> \param[out] WORK +*> \verbatim +*> WORK is COMPLEX array, dimension (max(M,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 complexGEcomputational +* @precisions normal c -> s d z +* +* +* Further Details +* =============== +*>\details \b Further \b Details +*> \verbatim *> *> The matrices Q and P are represented as products of elementary *> reflectors: |