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/spptrs.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/spptrs.f')
-rw-r--r-- | SRC/spptrs.f | 142 |
1 files changed, 101 insertions, 41 deletions
diff --git a/SRC/spptrs.f b/SRC/spptrs.f index ee5f3790..8c31b054 100644 --- a/SRC/spptrs.f +++ b/SRC/spptrs.f @@ -1,57 +1,117 @@ - SUBROUTINE SPPTRS( UPLO, N, NRHS, AP, B, LDB, INFO ) -* -* -- LAPACK 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 -- -* -* .. Scalar Arguments .. - CHARACTER UPLO - INTEGER INFO, LDB, N, NRHS -* .. -* .. Array Arguments .. - REAL AP( * ), B( LDB, * ) -* .. -* +*> \brief \b SPPTRS +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE SPPTRS( UPLO, N, NRHS, AP, B, LDB, INFO ) +* +* .. Scalar Arguments .. +* CHARACTER UPLO +* INTEGER INFO, LDB, N, NRHS +* .. +* .. Array Arguments .. +* REAL AP( * ), B( LDB, * ) +* .. +* * Purpose * ======= * -* SPPTRS solves a system of linear equations A*X = B with a symmetric -* positive definite matrix A in packed storage using the Cholesky -* factorization A = U**T*U or A = L*L**T computed by SPPTRF. +*>\details \b Purpose: +*>\verbatim +*> +*> SPPTRS solves a system of linear equations A*X = B with a symmetric +*> positive definite matrix A in packed storage using the Cholesky +*> factorization A = U**T*U or A = L*L**T computed by SPPTRF. +*> +*>\endverbatim * * Arguments * ========= * -* UPLO (input) CHARACTER*1 -* = 'U': Upper triangle of A is stored; -* = 'L': Lower triangle of A is stored. +*> \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 order of the matrix A. N >= 0. +*> \endverbatim +*> +*> \param[in] NRHS +*> \verbatim +*> NRHS is INTEGER +*> The number of right hand sides, i.e., the number of columns +*> of the matrix B. NRHS >= 0. +*> \endverbatim +*> +*> \param[in] AP +*> \verbatim +*> AP is REAL array, dimension (N*(N+1)/2) +*> The triangular factor U or L from the Cholesky factorization +*> A = U**T*U or A = L*L**T, packed columnwise in 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 +*> +*> \param[in,out] B +*> \verbatim +*> B is REAL array, dimension (LDB,NRHS) +*> On entry, the right hand side matrix B. +*> On exit, the solution matrix X. +*> \endverbatim +*> +*> \param[in] LDB +*> \verbatim +*> LDB is INTEGER +*> The leading dimension of the array B. LDB >= 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 +* ======= * -* N (input) INTEGER -* The order of the matrix A. N >= 0. +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* NRHS (input) INTEGER -* The number of right hand sides, i.e., the number of columns -* of the matrix B. NRHS >= 0. +*> \date November 2011 * -* AP (input) REAL array, dimension (N*(N+1)/2) -* The triangular factor U or L from the Cholesky factorization -* A = U**T*U or A = L*L**T, packed columnwise in 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. +*> \ingroup realOTHERcomputational * -* B (input/output) REAL array, dimension (LDB,NRHS) -* On entry, the right hand side matrix B. -* On exit, the solution matrix X. +* ===================================================================== + SUBROUTINE SPPTRS( UPLO, N, NRHS, AP, B, LDB, INFO ) * -* LDB (input) INTEGER -* The leading dimension of the array B. LDB >= max(1,N). +* -- 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..-- +* November 2011 * -* INFO (output) INTEGER -* = 0: successful exit -* < 0: if INFO = -i, the i-th argument had an illegal value +* .. Scalar Arguments .. + CHARACTER UPLO + INTEGER INFO, LDB, N, NRHS +* .. +* .. Array Arguments .. + REAL AP( * ), B( LDB, * ) +* .. * * ===================================================================== * |