From 0d9e213c670ab0e68f17d68251412d53250108e1 Mon Sep 17 00:00:00 2001 From: julie Date: Mon, 31 Oct 2011 22:21:11 +0000 Subject: 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. --- SRC/cgehrd.f | 82 ++++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 57 insertions(+), 25 deletions(-) (limited to 'SRC/cgehrd.f') diff --git a/SRC/cgehrd.f b/SRC/cgehrd.f index dcda32b4..19bcf5ad 100644 --- a/SRC/cgehrd.f +++ b/SRC/cgehrd.f @@ -45,60 +45,92 @@ *> 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 complexGEcomputational -* -* -* Further Details -* =============== -*>\details \b Further \b Details +*> \param[in] ILO *> \verbatim -* set to 1 and N respectively. See Further Details. +*> ILO is INTEGER +*> \endverbatim +*> +*> \param[in] IHI +*> \verbatim +*> IHI is INTEGER +*> +*> It is assumed that A is already upper triangular in rows +*> and columns 1:ILO-1 and IHI+1:N. ILO and IHI are normally +*> set by a previous call to CGEBAL; otherwise they should be +*> set to 1 and N respectively. See Further Details. *> 1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0, if N=0. +*> \endverbatim *> -*> A (input/output) COMPLEX array, dimension (LDA,N) +*> \param[in,out] A +*> \verbatim +*> A is COMPLEX array, dimension (LDA,N) *> On entry, the N-by-N general matrix to be reduced. *> On exit, the upper triangle and the first subdiagonal of A *> are overwritten with the upper Hessenberg matrix H, and the *> elements below the first subdiagonal, with the array TAU, *> represent the unitary 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 *> -*> TAU (output) COMPLEX array, dimension (N-1) +*> \param[out] TAU +*> \verbatim +*> TAU is COMPLEX array, dimension (N-1) *> The scalar factors of the elementary reflectors (see Further *> Details). Elements 1:ILO-1 and IHI:N-1 of TAU are set to *> zero. +*> \endverbatim *> -*> WORK (workspace/output) COMPLEX array, dimension (LWORK) +*> \param[out] WORK +*> \verbatim +*> WORK is COMPLEX array, dimension (LWORK) *> On exit, if INFO = 0, WORK(1) returns the optimal LWORK. +*> \endverbatim *> -*> LWORK (input) INTEGER +*> \param[in] LWORK +*> \verbatim +*> LWORK is INTEGER *> The length of the array WORK. LWORK >= max(1,N). *> For optimum performance LWORK >= N*NB, where NB is the *> optimal blocksize. -*> +*> \endverbatim +*> \verbatim *> If LWORK = -1, then a workspace query is assumed; the routine *> 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 (ihi-ilo) elementary *> reflectors -- cgit v1.2.3