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/cla_porcond_c.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/cla_porcond_c.f')
-rw-r--r-- | SRC/cla_porcond_c.f | 180 |
1 files changed, 125 insertions, 55 deletions
diff --git a/SRC/cla_porcond_c.f b/SRC/cla_porcond_c.f index 73c1cae7..a1a01f0b 100644 --- a/SRC/cla_porcond_c.f +++ b/SRC/cla_porcond_c.f @@ -1,71 +1,141 @@ - REAL FUNCTION CLA_PORCOND_C( UPLO, N, A, LDA, AF, LDAF, C, CAPPLY, - $ INFO, WORK, RWORK ) -* -* -- LAPACK routine (version 3.2.1) -- -* -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and -- -* -- Jason Riedy of Univ. of California Berkeley. -- -* -- April 2009 -- -* -* -- LAPACK is a software package provided by Univ. of Tennessee, -- -* -- Univ. of California Berkeley and NAG Ltd. -- -* - IMPLICIT NONE -* .. -* .. Scalar Arguments .. - CHARACTER UPLO - LOGICAL CAPPLY - INTEGER N, LDA, LDAF, INFO -* .. -* .. Array Arguments .. - COMPLEX A( LDA, * ), AF( LDAF, * ), WORK( * ) - REAL C( * ), RWORK( * ) -* .. -* +*> \brief \b CLA_PORCOND_C +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* REAL FUNCTION CLA_PORCOND_C( UPLO, N, A, LDA, AF, LDAF, C, CAPPLY, +* INFO, WORK, RWORK ) +* +* .. Scalar Arguments .. +* CHARACTER UPLO +* LOGICAL CAPPLY +* INTEGER N, LDA, LDAF, INFO +* .. +* .. Array Arguments .. +* COMPLEX A( LDA, * ), AF( LDAF, * ), WORK( * ) +* REAL C( * ), RWORK( * ) +* .. +* * Purpose * ======= * -* CLA_PORCOND_C Computes the infinity norm condition number of -* op(A) * inv(diag(C)) where C is a DOUBLE PRECISION vector +*>\details \b Purpose: +*>\verbatim +*> +*> CLA_PORCOND_C Computes the infinity norm condition number of +*> op(A) * inv(diag(C)) where C is a DOUBLE PRECISION vector +*> +*>\endverbatim * * Arguments * ========= * -* UPLO (input) CHARACTER*1 -* = 'U': Upper triangle of A is stored; -* = 'L': Lower triangle of A is stored. -* -* N (input) INTEGER -* The number of linear equations, i.e., the order of the -* matrix A. N >= 0. -* -* A (input) COMPLEX array, dimension (LDA,N) -* On entry, the N-by-N matrix A -* -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(1,N). -* -* AF (input) COMPLEX array, dimension (LDAF,N) -* The triangular factor U or L from the Cholesky factorization -* A = U**H*U or A = L*L**H, as computed by CPOTRF. +*> \param[in] UPLO +*> \verbatim +*> UPLO is CHARACTER*1 +*> = 'U': Upper triangle of A is stored; +*> = 'L': Lower triangle of A is stored. +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of linear equations, i.e., the order of the +*> matrix A. N >= 0. +*> \endverbatim +*> +*> \param[in] A +*> \verbatim +*> A is COMPLEX array, dimension (LDA,N) +*> On entry, the N-by-N matrix A +*> \endverbatim +*> +*> \param[in] LDA +*> \verbatim +*> LDA is INTEGER +*> The leading dimension of the array A. LDA >= max(1,N). +*> \endverbatim +*> +*> \param[in] AF +*> \verbatim +*> AF is COMPLEX array, dimension (LDAF,N) +*> The triangular factor U or L from the Cholesky factorization +*> A = U**H*U or A = L*L**H, as computed by CPOTRF. +*> \endverbatim +*> +*> \param[in] LDAF +*> \verbatim +*> LDAF is INTEGER +*> The leading dimension of the array AF. LDAF >= max(1,N). +*> \endverbatim +*> +*> \param[in] C +*> \verbatim +*> C is REAL array, dimension (N) +*> The vector C in the formula op(A) * inv(diag(C)). +*> \endverbatim +*> +*> \param[in] CAPPLY +*> \verbatim +*> CAPPLY is LOGICAL +*> If .TRUE. then access the vector C in the formula above. +*> \endverbatim +*> +*> \param[out] INFO +*> \verbatim +*> INFO is INTEGER +*> = 0: Successful exit. +*> i > 0: The ith argument is invalid. +*> \endverbatim +*> +*> \param[in] WORK +*> \verbatim +*> WORK is COMPLEX array, dimension (2*N). +*> Workspace. +*> \endverbatim +*> +*> \param[in] RWORK +*> \verbatim +*> RWORK is REAL array, dimension (N). +*> Workspace. +*> \endverbatim +*> +* +* Authors +* ======= * -* LDAF (input) INTEGER -* The leading dimension of the array AF. LDAF >= max(1,N). +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* C (input) REAL array, dimension (N) -* The vector C in the formula op(A) * inv(diag(C)). +*> \date November 2011 * -* CAPPLY (input) LOGICAL -* If .TRUE. then access the vector C in the formula above. +*> \ingroup complexPOcomputational * -* INFO (output) INTEGER -* = 0: Successful exit. -* i > 0: The ith argument is invalid. +* ===================================================================== + REAL FUNCTION CLA_PORCOND_C( UPLO, N, A, LDA, AF, LDAF, C, CAPPLY, + $ INFO, WORK, RWORK ) * -* WORK (input) COMPLEX array, dimension (2*N). -* Workspace. +* -- LAPACK computational routine (version 3.2.1) -- +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 * -* RWORK (input) REAL array, dimension (N). -* Workspace. +* .. Scalar Arguments .. + CHARACTER UPLO + LOGICAL CAPPLY + INTEGER N, LDA, LDAF, INFO +* .. +* .. Array Arguments .. + COMPLEX A( LDA, * ), AF( LDAF, * ), WORK( * ) + REAL C( * ), RWORK( * ) +* .. * * ===================================================================== * |