From e1d39294aee16fa6db9ba079b14442358217db71 Mon Sep 17 00:00:00 2001 From: julie Date: Thu, 6 Oct 2011 06:53:11 +0000 Subject: Integrating Doxygen in comments --- SRC/cggbak.f | 205 +++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 142 insertions(+), 63 deletions(-) (limited to 'SRC/cggbak.f') diff --git a/SRC/cggbak.f b/SRC/cggbak.f index 86818b1b..c9ce3d8a 100644 --- a/SRC/cggbak.f +++ b/SRC/cggbak.f @@ -1,81 +1,160 @@ - SUBROUTINE CGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V, - $ LDV, INFO ) -* -* -- LAPACK routine (version 3.2) -- -* -- LAPACK is a software package provided by Univ. of Tennessee, -- -* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* November 2006 -* -* .. Scalar Arguments .. - CHARACTER JOB, SIDE - INTEGER IHI, ILO, INFO, LDV, M, N -* .. -* .. Array Arguments .. - REAL LSCALE( * ), RSCALE( * ) - COMPLEX V( LDV, * ) -* .. -* +*> \brief \b CGGBAK +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE CGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V, +* LDV, INFO ) +* +* .. Scalar Arguments .. +* CHARACTER JOB, SIDE +* INTEGER IHI, ILO, INFO, LDV, M, N +* .. +* .. Array Arguments .. +* REAL LSCALE( * ), RSCALE( * ) +* COMPLEX V( LDV, * ) +* .. +* * Purpose * ======= * -* CGGBAK forms the right or left eigenvectors of a complex generalized -* eigenvalue problem A*x = lambda*B*x, by backward transformation on -* the computed eigenvectors of the balanced pair of matrices output by -* CGGBAL. +*>\details \b Purpose: +*>\verbatim +*> +*> CGGBAK forms the right or left eigenvectors of a complex generalized +*> eigenvalue problem A*x = lambda*B*x, by backward transformation on +*> the computed eigenvectors of the balanced pair of matrices output by +*> CGGBAL. +*> +*>\endverbatim * * Arguments * ========= * -* JOB (input) CHARACTER*1 -* Specifies the type of backward transformation required: -* = 'N': do nothing, return immediately; -* = 'P': do backward transformation for permutation only; -* = 'S': do backward transformation for scaling only; -* = 'B': do backward transformations for both permutation and -* scaling. -* JOB must be the same as the argument JOB supplied to CGGBAL. -* -* SIDE (input) CHARACTER*1 -* = 'R': V contains right eigenvectors; -* = 'L': V contains left eigenvectors. -* -* N (input) INTEGER -* The number of rows of the matrix V. N >= 0. -* -* ILO (input) INTEGER -* -* IHI (input) INTEGER -* The integers ILO and IHI determined by CGGBAL. -* 1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0, if N=0. -* -* LSCALE (input) REAL array, dimension (N) -* Details of the permutations and/or scaling factors applied -* to the left side of A and B, as returned by CGGBAL. -* -* RSCALE (input) REAL array, dimension (N) -* Details of the permutations and/or scaling factors applied -* to the right side of A and B, as returned by CGGBAL. +*> \param[in] JOB +*> \verbatim +*> JOB is CHARACTER*1 +*> Specifies the type of backward transformation required: +*> = 'N': do nothing, return immediately; +*> = 'P': do backward transformation for permutation only; +*> = 'S': do backward transformation for scaling only; +*> = 'B': do backward transformations for both permutation and +*> scaling. +*> JOB must be the same as the argument JOB supplied to CGGBAL. +*> \endverbatim +*> +*> \param[in] SIDE +*> \verbatim +*> SIDE is CHARACTER*1 +*> = 'R': V contains right eigenvectors; +*> = 'L': V contains left eigenvectors. +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of rows of the matrix V. N >= 0. +*> \endverbatim +*> +*> \param[in] ILO +*> \verbatim +*> ILO is INTEGER +*> \endverbatim +*> +*> \param[in] IHI +*> \verbatim +*> IHI is INTEGER +*> The integers ILO and IHI determined by CGGBAL. +*> 1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0, if N=0. +*> \endverbatim +*> +*> \param[in] LSCALE +*> \verbatim +*> LSCALE is REAL array, dimension (N) +*> Details of the permutations and/or scaling factors applied +*> to the left side of A and B, as returned by CGGBAL. +*> \endverbatim +*> +*> \param[in] RSCALE +*> \verbatim +*> RSCALE is REAL array, dimension (N) +*> Details of the permutations and/or scaling factors applied +*> to the right side of A and B, as returned by CGGBAL. +*> \endverbatim +*> +*> \param[in] M +*> \verbatim +*> M is INTEGER +*> The number of columns of the matrix V. M >= 0. +*> \endverbatim +*> +*> \param[in,out] V +*> \verbatim +*> V is COMPLEX array, dimension (LDV,M) +*> On entry, the matrix of right or left eigenvectors to be +*> transformed, as returned by CTGEVC. +*> On exit, V is overwritten by the transformed eigenvectors. +*> \endverbatim +*> +*> \param[in] LDV +*> \verbatim +*> LDV is INTEGER +*> The leading dimension of the matrix V. LDV >= max(1,N). +*> \endverbatim +*> +*> \param[out] INFO +*> \verbatim +*> INFO is INTEGER +*> = 0: successful exit. +*> < 0: if INFO = -i, the i-th argument had an illegal value. +*> \endverbatim +*> +* +* Authors +* ======= * -* M (input) INTEGER -* The number of columns of the matrix V. M >= 0. +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* V (input/output) COMPLEX array, dimension (LDV,M) -* On entry, the matrix of right or left eigenvectors to be -* transformed, as returned by CTGEVC. -* On exit, V is overwritten by the transformed eigenvectors. +*> \date November 2011 * -* LDV (input) INTEGER -* The leading dimension of the matrix V. LDV >= max(1,N). +*> \ingroup complexGBcomputational * -* INFO (output) INTEGER -* = 0: successful exit. -* < 0: if INFO = -i, the i-th argument had an illegal value. * * Further Details * =============== +*>\details \b Further \b Details +*> \verbatim +*> +*> See R.C. Ward, Balancing the generalized eigenvalue problem, +*> SIAM J. Sci. Stat. Comp. 2 (1981), 141-152. +*> +*> \endverbatim +*> +* ===================================================================== + SUBROUTINE CGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V, + $ LDV, INFO ) +* +* -- LAPACK computational routine (version 3.2) -- +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 * -* See R.C. Ward, Balancing the generalized eigenvalue problem, -* SIAM J. Sci. Stat. Comp. 2 (1981), 141-152. +* .. Scalar Arguments .. + CHARACTER JOB, SIDE + INTEGER IHI, ILO, INFO, LDV, M, N +* .. +* .. Array Arguments .. + REAL LSCALE( * ), RSCALE( * ) + COMPLEX V( LDV, * ) +* .. * * ===================================================================== * -- cgit v1.2.3