diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/zlaqsy.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/zlaqsy.f')
-rw-r--r-- | SRC/zlaqsy.f | 189 |
1 files changed, 129 insertions, 60 deletions
diff --git a/SRC/zlaqsy.f b/SRC/zlaqsy.f index cab43382..d483235f 100644 --- a/SRC/zlaqsy.f +++ b/SRC/zlaqsy.f @@ -1,9 +1,137 @@ +*> \brief \b ZLAQSY +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE ZLAQSY( UPLO, N, A, LDA, S, SCOND, AMAX, EQUED ) +* +* .. Scalar Arguments .. +* CHARACTER EQUED, UPLO +* INTEGER LDA, N +* DOUBLE PRECISION AMAX, SCOND +* .. +* .. Array Arguments .. +* DOUBLE PRECISION S( * ) +* COMPLEX*16 A( LDA, * ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> ZLAQSY equilibrates a symmetric matrix A using the scaling factors +*> in the vector S. +*> +*>\endverbatim +* +* Arguments +* ========= +* +*> \param[in] UPLO +*> \verbatim +*> UPLO is CHARACTER*1 +*> Specifies whether the upper or lower triangular part of the +*> symmetric matrix A is stored. +*> = 'U': Upper triangular +*> = 'L': Lower triangular +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The order of the matrix A. N >= 0. +*> \endverbatim +*> +*> \param[in,out] A +*> \verbatim +*> A is COMPLEX*16 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. +*> \endverbatim +*> \verbatim +*> On exit, if EQUED = 'Y', the equilibrated matrix: +*> diag(S) * A * diag(S). +*> \endverbatim +*> +*> \param[in] LDA +*> \verbatim +*> LDA is INTEGER +*> The leading dimension of the array A. LDA >= max(N,1). +*> \endverbatim +*> +*> \param[in] S +*> \verbatim +*> S is DOUBLE PRECISION array, dimension (N) +*> The scale factors for A. +*> \endverbatim +*> +*> \param[in] SCOND +*> \verbatim +*> SCOND is DOUBLE PRECISION +*> Ratio of the smallest S(i) to the largest S(i). +*> \endverbatim +*> +*> \param[in] AMAX +*> \verbatim +*> AMAX is DOUBLE PRECISION +*> Absolute value of largest matrix entry. +*> \endverbatim +*> +*> \param[out] EQUED +*> \verbatim +*> EQUED is CHARACTER*1 +*> Specifies whether or not equilibration was done. +*> = 'N': No equilibration. +*> = 'Y': Equilibration was done, i.e., A has been replaced by +*> diag(S) * A * diag(S). +*> \endverbatim +*> \verbatim +*> Internal Parameters +*> =================== +*> \endverbatim +*> \verbatim +*> THRESH is a threshold value used to decide if scaling should be done +*> based on the ratio of the scaling factors. If SCOND < THRESH, +*> scaling is done. +*> \endverbatim +*> \verbatim +*> LARGE and SMALL are threshold values used to decide if scaling should +*> be done based on the absolute size of the largest matrix element. +*> If AMAX > LARGE or AMAX < SMALL, scaling is done. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. +* +*> \date November 2011 +* +*> \ingroup complex16SYauxiliary +* +* ===================================================================== SUBROUTINE ZLAQSY( UPLO, N, A, LDA, S, SCOND, AMAX, EQUED ) * * -- LAPACK auxiliary 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 +* November 2011 * * .. Scalar Arguments .. CHARACTER EQUED, UPLO @@ -15,65 +143,6 @@ COMPLEX*16 A( LDA, * ) * .. * -* Purpose -* ======= -* -* ZLAQSY equilibrates a symmetric matrix A using the scaling factors -* in the vector S. -* -* Arguments -* ========= -* -* UPLO (input) CHARACTER*1 -* Specifies whether the upper or lower triangular part of the -* symmetric matrix A is stored. -* = 'U': Upper triangular -* = 'L': Lower triangular -* -* N (input) INTEGER -* The order of the matrix A. N >= 0. -* -* A (input/output) COMPLEX*16 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 EQUED = 'Y', the equilibrated matrix: -* diag(S) * A * diag(S). -* -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(N,1). -* -* S (input) DOUBLE PRECISION array, dimension (N) -* The scale factors for A. -* -* SCOND (input) DOUBLE PRECISION -* Ratio of the smallest S(i) to the largest S(i). -* -* AMAX (input) DOUBLE PRECISION -* Absolute value of largest matrix entry. -* -* EQUED (output) CHARACTER*1 -* Specifies whether or not equilibration was done. -* = 'N': No equilibration. -* = 'Y': Equilibration was done, i.e., A has been replaced by -* diag(S) * A * diag(S). -* -* Internal Parameters -* =================== -* -* THRESH is a threshold value used to decide if scaling should be done -* based on the ratio of the scaling factors. If SCOND < THRESH, -* scaling is done. -* -* LARGE and SMALL are threshold values used to decide if scaling should -* be done based on the absolute size of the largest matrix element. -* If AMAX > LARGE or AMAX < SMALL, scaling is done. -* * ===================================================================== * * .. Parameters .. |