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/cpstf2.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/cpstf2.f')
-rw-r--r-- | SRC/cpstf2.f | 205 |
1 files changed, 138 insertions, 67 deletions
diff --git a/SRC/cpstf2.f b/SRC/cpstf2.f index 4684c6c0..10a54fda 100644 --- a/SRC/cpstf2.f +++ b/SRC/cpstf2.f @@ -1,8 +1,143 @@ +*> \brief \b CPSTF2 +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE CPSTF2( UPLO, N, A, LDA, PIV, RANK, TOL, WORK, INFO ) +* +* .. Scalar Arguments .. +* REAL TOL +* INTEGER INFO, LDA, N, RANK +* CHARACTER UPLO +* .. +* .. Array Arguments .. +* COMPLEX A( LDA, * ) +* REAL WORK( 2*N ) +* INTEGER PIV( N ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> CPSTF2 computes the Cholesky factorization with complete +*> pivoting of a complex Hermitian positive semidefinite matrix A. +*> +*> The factorization has the form +*> P**T * A * P = U**H * U , if UPLO = 'U', +*> P**T * A * P = L * L**H, if UPLO = 'L', +*> where U is an upper triangular matrix and L is lower triangular, and +*> P is stored as vector PIV. +*> +*> This algorithm does not attempt to check that A is positive +*> semidefinite. This version of the algorithm calls level 2 BLAS. +*> +*>\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 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 INFO = 0, the factor U or L from the Cholesky +*> factorization as above. +*> \endverbatim +*> +*> \param[out] PIV +*> \verbatim +*> PIV is INTEGER array, dimension (N) +*> PIV is such that the nonzero entries are P( PIV(K), K ) = 1. +*> \endverbatim +*> +*> \param[out] RANK +*> \verbatim +*> RANK is INTEGER +*> The rank of A given by the number of steps the algorithm +*> completed. +*> \endverbatim +*> +*> \param[in] TOL +*> \verbatim +*> TOL is REAL +*> User defined tolerance. If TOL < 0, then N*U*MAX( A( K,K ) ) +*> will be used. The algorithm terminates at the (K-1)st step +*> if the pivot <= TOL. +*> \endverbatim +*> +*> \param[in] LDA +*> \verbatim +*> LDA is INTEGER +*> The leading dimension of the array A. LDA >= max(1,N). +*> \endverbatim +*> +*> \param[out] WORK +*> \verbatim +*> WORK is REAL array, dimension (2*N) +*> Work space. +*> \endverbatim +*> +*> \param[out] INFO +*> \verbatim +*> INFO is INTEGER +*> < 0: If INFO = -K, the K-th argument had an illegal value, +*> = 0: algorithm completed successfully, and +*> > 0: the matrix A is either rank deficient with computed rank +*> as returned in RANK, or is indefinite. See Section 7 of +*> LAPACK Working Note #161 for further information. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. +* +*> \date November 2011 +* +*> \ingroup complexOTHERcomputational +* +* ===================================================================== SUBROUTINE CPSTF2( UPLO, N, A, LDA, PIV, RANK, TOL, WORK, INFO ) * -* -- LAPACK PROTOTYPE routine (version 3.2.2) -- -* Craig Lucas, University of Manchester / NAG Ltd. -* October, 2008 +* -- LAPACK computational routine (version 3.2.2) -- +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 * * .. Scalar Arguments .. REAL TOL @@ -15,70 +150,6 @@ INTEGER PIV( N ) * .. * -* Purpose -* ======= -* -* CPSTF2 computes the Cholesky factorization with complete -* pivoting of a complex Hermitian positive semidefinite matrix A. -* -* The factorization has the form -* P**T * A * P = U**H * U , if UPLO = 'U', -* P**T * A * P = L * L**H, if UPLO = 'L', -* where U is an upper triangular matrix and L is lower triangular, and -* P is stored as vector PIV. -* -* This algorithm does not attempt to check that A is positive -* semidefinite. This version of the algorithm calls level 2 BLAS. -* -* 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 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 INFO = 0, the factor U or L from the Cholesky -* factorization as above. -* -* PIV (output) INTEGER array, dimension (N) -* PIV is such that the nonzero entries are P( PIV(K), K ) = 1. -* -* RANK (output) INTEGER -* The rank of A given by the number of steps the algorithm -* completed. -* -* TOL (input) REAL -* User defined tolerance. If TOL < 0, then N*U*MAX( A( K,K ) ) -* will be used. The algorithm terminates at the (K-1)st step -* if the pivot <= TOL. -* -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(1,N). -* -* WORK (workspace) REAL array, dimension (2*N) -* Work space. -* -* INFO (output) INTEGER -* < 0: If INFO = -K, the K-th argument had an illegal value, -* = 0: algorithm completed successfully, and -* > 0: the matrix A is either rank deficient with computed rank -* as returned in RANK, or is indefinite. See Section 7 of -* LAPACK Working Note #161 for further information. -* * ===================================================================== * * .. Parameters .. |