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/ssytrd.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/ssytrd.f')
-rw-r--r-- | SRC/ssytrd.f | 91 |
1 files changed, 66 insertions, 25 deletions
diff --git a/SRC/ssytrd.f b/SRC/ssytrd.f index 1a501791..104f2a53 100644 --- a/SRC/ssytrd.f +++ b/SRC/ssytrd.f @@ -55,45 +55,64 @@ *> 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 realSYcomputational -* -* -* Further Details -* =============== -*>\details \b Further \b Details +*> \param[in,out] A *> \verbatim -* of elementary reflectors. See Further Details. +*> A is REAL array, dimension (LDA,N) +*> On entry, the symmetric matrix A. If UPLO = 'U', the leading +*> N-by-N upper triangular part of A contains the upper +*> triangular part of the matrix A, and the strictly lower +*> triangular part of A is not referenced. If UPLO = 'L', the +*> leading N-by-N lower triangular part of A contains the lower +*> triangular part of the matrix A, and the strictly upper +*> triangular part of A is not referenced. +*> On exit, if UPLO = 'U', the diagonal and first superdiagonal +*> of A are overwritten by the corresponding elements of the +*> tridiagonal matrix T, and the elements above the first +*> superdiagonal, with the array TAU, represent the orthogonal +*> matrix Q as a product of elementary reflectors; if UPLO +*> = 'L', the diagonal and first subdiagonal of A are over- +*> written by the corresponding elements of the tridiagonal +*> matrix T, and the elements below the first subdiagonal, with +*> the array TAU, represent the orthogonal matrix Q 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,N). +*> \endverbatim *> -*> D (output) REAL array, dimension (N) +*> \param[out] D +*> \verbatim +*> D is REAL array, dimension (N) *> The diagonal elements of the tridiagonal matrix T: *> D(i) = A(i,i). +*> \endverbatim *> -*> E (output) REAL array, dimension (N-1) +*> \param[out] E +*> \verbatim +*> E is REAL array, dimension (N-1) *> The off-diagonal elements of the tridiagonal matrix T: *> E(i) = A(i,i+1) if UPLO = 'U', E(i) = A(i+1,i) if UPLO = 'L'. +*> \endverbatim *> -*> TAU (output) REAL array, dimension (N-1) +*> \param[out] TAU +*> \verbatim +*> TAU is REAL array, dimension (N-1) *> The scalar factors of the elementary reflectors (see Further *> Details). +*> \endverbatim *> -*> WORK (workspace/output) REAL array, dimension (MAX(1,LWORK)) +*> \param[out] WORK +*> \verbatim +*> WORK is REAL 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 >= 1. *> For optimum performance LWORK >= N*NB, where NB is the *> optimal blocksize. @@ -102,11 +121,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 realSYcomputational +* +* +* Further Details +* =============== +*>\details \b Further \b Details +*> \verbatim *> *> If UPLO = 'U', the matrix Q is represented as a product of elementary *> reflectors |