summaryrefslogtreecommitdiff
path: root/TESTING/LIN/dpbt01.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 /TESTING/LIN/dpbt01.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/LIN/dpbt01.f')
-rw-r--r--TESTING/LIN/dpbt01.f177
1 files changed, 123 insertions, 54 deletions
diff --git a/TESTING/LIN/dpbt01.f b/TESTING/LIN/dpbt01.f
index 94df9f94..34a846f1 100644
--- a/TESTING/LIN/dpbt01.f
+++ b/TESTING/LIN/dpbt01.f
@@ -1,70 +1,139 @@
- SUBROUTINE DPBT01( UPLO, N, KD, A, LDA, AFAC, LDAFAC, RWORK,
- $ RESID )
-*
-* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
-*
-* .. Scalar Arguments ..
- CHARACTER UPLO
- INTEGER KD, LDA, LDAFAC, N
- DOUBLE PRECISION RESID
-* ..
-* .. Array Arguments ..
- DOUBLE PRECISION A( LDA, * ), AFAC( LDAFAC, * ), RWORK( * )
-* ..
-*
+*> \brief \b DPBT01
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE DPBT01( UPLO, N, KD, A, LDA, AFAC, LDAFAC, RWORK,
+* RESID )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER KD, LDA, LDAFAC, N
+* DOUBLE PRECISION RESID
+* ..
+* .. Array Arguments ..
+* DOUBLE PRECISION A( LDA, * ), AFAC( LDAFAC, * ), RWORK( * )
+* ..
+*
* Purpose
* =======
*
-* DPBT01 reconstructs a symmetric positive definite band matrix A from
-* its L*L' or U'*U factorization and computes the residual
-* norm( L*L' - A ) / ( N * norm(A) * EPS ) or
-* norm( U'*U - A ) / ( N * norm(A) * EPS ),
-* where EPS is the machine epsilon, L' is the conjugate transpose of
-* L, and U' is the conjugate transpose of U.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DPBT01 reconstructs a symmetric positive definite band matrix A from
+*> its L*L' or U'*U factorization and computes the residual
+*> norm( L*L' - A ) / ( N * norm(A) * EPS ) or
+*> norm( U'*U - A ) / ( N * norm(A) * EPS ),
+*> where EPS is the machine epsilon, L' is the conjugate transpose of
+*> L, and U' is the conjugate transpose of U.
+*>
+*>\endverbatim
*
* 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 number of rows and columns of the matrix A. N >= 0.
-*
-* KD (input) INTEGER
-* The number of super-diagonals of the matrix A if UPLO = 'U',
-* or the number of sub-diagonals if UPLO = 'L'. KD >= 0.
+*> \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 number of rows and columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] KD
+*> \verbatim
+*> KD is INTEGER
+*> The number of super-diagonals of the matrix A if UPLO = 'U',
+*> or the number of sub-diagonals if UPLO = 'L'. KD >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is DOUBLE PRECISION array, dimension (LDA,N)
+*> The original symmetric band matrix A. If UPLO = 'U', the
+*> upper triangular part of A is stored as a band matrix; if
+*> UPLO = 'L', the lower triangular part of A is stored. The
+*> columns of the appropriate triangle are stored in the columns
+*> of A and the diagonals of the triangle are stored in the rows
+*> of A. See DPBTRF for further details.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER.
+*> The leading dimension of the array A. LDA >= max(1,KD+1).
+*> \endverbatim
+*>
+*> \param[in] AFAC
+*> \verbatim
+*> AFAC is DOUBLE PRECISION array, dimension (LDAFAC,N)
+*> The factored form of the matrix A. AFAC contains the factor
+*> L or U from the L*L' or U'*U factorization in band storage
+*> format, as computed by DPBTRF.
+*> \endverbatim
+*>
+*> \param[in] LDAFAC
+*> \verbatim
+*> LDAFAC is INTEGER
+*> The leading dimension of the array AFAC.
+*> LDAFAC >= max(1,KD+1).
+*> \endverbatim
+*>
+*> \param[out] RWORK
+*> \verbatim
+*> RWORK is DOUBLE PRECISION array, dimension (N)
+*> \endverbatim
+*>
+*> \param[out] RESID
+*> \verbatim
+*> RESID is DOUBLE PRECISION
+*> If UPLO = 'L', norm(L*L' - A) / ( N * norm(A) * EPS )
+*> If UPLO = 'U', norm(U'*U - A) / ( N * norm(A) * EPS )
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* A (input) DOUBLE PRECISION array, dimension (LDA,N)
-* The original symmetric band matrix A. If UPLO = 'U', the
-* upper triangular part of A is stored as a band matrix; if
-* UPLO = 'L', the lower triangular part of A is stored. The
-* columns of the appropriate triangle are stored in the columns
-* of A and the diagonals of the triangle are stored in the rows
-* of A. See DPBTRF for further details.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* LDA (input) INTEGER.
-* The leading dimension of the array A. LDA >= max(1,KD+1).
+*> \date November 2011
*
-* AFAC (input) DOUBLE PRECISION array, dimension (LDAFAC,N)
-* The factored form of the matrix A. AFAC contains the factor
-* L or U from the L*L' or U'*U factorization in band storage
-* format, as computed by DPBTRF.
+*> \ingroup double_lin
*
-* LDAFAC (input) INTEGER
-* The leading dimension of the array AFAC.
-* LDAFAC >= max(1,KD+1).
+* =====================================================================
+ SUBROUTINE DPBT01( UPLO, N, KD, A, LDA, AFAC, LDAFAC, RWORK,
+ $ RESID )
*
-* RWORK (workspace) DOUBLE PRECISION array, dimension (N)
+* -- LAPACK test routine (version 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
*
-* RESID (output) DOUBLE PRECISION
-* If UPLO = 'L', norm(L*L' - A) / ( N * norm(A) * EPS )
-* If UPLO = 'U', norm(U'*U - A) / ( N * norm(A) * EPS )
+* .. Scalar Arguments ..
+ CHARACTER UPLO
+ INTEGER KD, LDA, LDAFAC, N
+ DOUBLE PRECISION RESID
+* ..
+* .. Array Arguments ..
+ DOUBLE PRECISION A( LDA, * ), AFAC( LDAFAC, * ), RWORK( * )
+* ..
*
* =====================================================================
*