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/cpptri.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/cpptri.f')
-rw-r--r-- | SRC/cpptri.f | 124 |
1 files changed, 88 insertions, 36 deletions
diff --git a/SRC/cpptri.f b/SRC/cpptri.f index ae2c8a30..98b8a305 100644 --- a/SRC/cpptri.f +++ b/SRC/cpptri.f @@ -1,9 +1,95 @@ +*> \brief \b CPPTRI +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE CPPTRI( UPLO, N, AP, INFO ) +* +* .. Scalar Arguments .. +* CHARACTER UPLO +* INTEGER INFO, N +* .. +* .. Array Arguments .. +* COMPLEX AP( * ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> CPPTRI computes the inverse of a complex Hermitian positive definite +*> matrix A using the Cholesky factorization A = U**H*U or A = L*L**H +*> computed by CPPTRF. +*> +*>\endverbatim +* +* Arguments +* ========= +* +*> \param[in] UPLO +*> \verbatim +*> UPLO is CHARACTER*1 +*> = 'U': Upper triangular factor is stored in AP; +*> = 'L': Lower triangular factor is stored in AP. +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The order of the matrix A. N >= 0. +*> \endverbatim +*> +*> \param[in,out] AP +*> \verbatim +*> AP is COMPLEX array, dimension (N*(N+1)/2) +*> On entry, the triangular factor U or L from the Cholesky +*> factorization A = U**H*U or A = L*L**H, packed columnwise as +*> a linear array. The j-th column of U or L is stored in the +*> array AP as follows: +*> if UPLO = 'U', AP(i + (j-1)*j/2) = U(i,j) for 1<=i<=j; +*> if UPLO = 'L', AP(i + (j-1)*(2n-j)/2) = L(i,j) for j<=i<=n. +*> \endverbatim +*> \verbatim +*> On exit, the upper or lower triangle of the (Hermitian) +*> inverse of A, overwriting the input factor U or L. +*> \endverbatim +*> +*> \param[out] INFO +*> \verbatim +*> INFO is INTEGER +*> = 0: successful exit +*> < 0: if INFO = -i, the i-th argument had an illegal value +*> > 0: if INFO = i, the (i,i) element of the factor U or L is +*> zero, and the inverse could not be computed. +*> \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 CPPTRI( UPLO, N, AP, INFO ) * -* -- LAPACK routine (version 3.3.1) -- +* -- LAPACK computational routine (version 3.3.1) -- * -- LAPACK is a software package provided by Univ. of Tennessee, -- * -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* -- April 2011 -- +* November 2011 * * .. Scalar Arguments .. CHARACTER UPLO @@ -13,40 +99,6 @@ COMPLEX AP( * ) * .. * -* Purpose -* ======= -* -* CPPTRI computes the inverse of a complex Hermitian positive definite -* matrix A using the Cholesky factorization A = U**H*U or A = L*L**H -* computed by CPPTRF. -* -* Arguments -* ========= -* -* UPLO (input) CHARACTER*1 -* = 'U': Upper triangular factor is stored in AP; -* = 'L': Lower triangular factor is stored in AP. -* -* N (input) INTEGER -* The order of the matrix A. N >= 0. -* -* AP (input/output) COMPLEX array, dimension (N*(N+1)/2) -* On entry, the triangular factor U or L from the Cholesky -* factorization A = U**H*U or A = L*L**H, packed columnwise as -* a linear array. The j-th column of U or L is stored in the -* array AP as follows: -* if UPLO = 'U', AP(i + (j-1)*j/2) = U(i,j) for 1<=i<=j; -* if UPLO = 'L', AP(i + (j-1)*(2n-j)/2) = L(i,j) for j<=i<=n. -* -* On exit, the upper or lower triangle of the (Hermitian) -* inverse of A, overwriting the input factor U or L. -* -* INFO (output) INTEGER -* = 0: successful exit -* < 0: if INFO = -i, the i-th argument had an illegal value -* > 0: if INFO = i, the (i,i) element of the factor U or L is -* zero, and the inverse could not be computed. -* * ===================================================================== * * .. Parameters .. |