summaryrefslogtreecommitdiff
path: root/SRC/dpptrs.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
commite1d39294aee16fa6db9ba079b14442358217db71 (patch)
tree30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/dpptrs.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/dpptrs.f')
-rw-r--r--SRC/dpptrs.f142
1 files changed, 101 insertions, 41 deletions
diff --git a/SRC/dpptrs.f b/SRC/dpptrs.f
index 5f05d030..92a17f1c 100644
--- a/SRC/dpptrs.f
+++ b/SRC/dpptrs.f
@@ -1,57 +1,117 @@
- SUBROUTINE DPPTRS( 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 ..
- DOUBLE PRECISION AP( * ), B( LDB, * )
-* ..
-*
+*> \brief \b DPPTRS
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE DPPTRS( UPLO, N, NRHS, AP, B, LDB, INFO )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER INFO, LDB, N, NRHS
+* ..
+* .. Array Arguments ..
+* DOUBLE PRECISION AP( * ), B( LDB, * )
+* ..
+*
* Purpose
* =======
*
-* DPPTRS 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 DPPTRF.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DPPTRS 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 DPPTRF.
+*>
+*>\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 DOUBLE PRECISION 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 DOUBLE PRECISION 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) DOUBLE PRECISION 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 doubleOTHERcomputational
*
-* B (input/output) DOUBLE PRECISION array, dimension (LDB,NRHS)
-* On entry, the right hand side matrix B.
-* On exit, the solution matrix X.
+* =====================================================================
+ SUBROUTINE DPPTRS( 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 ..
+ DOUBLE PRECISION AP( * ), B( LDB, * )
+* ..
*
* =====================================================================
*