From e1d39294aee16fa6db9ba079b14442358217db71 Mon Sep 17 00:00:00 2001 From: julie Date: Thu, 6 Oct 2011 06:53:11 +0000 Subject: Integrating Doxygen in comments --- TESTING/LIN/dgbt02.f | 205 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 143 insertions(+), 62 deletions(-) (limited to 'TESTING/LIN/dgbt02.f') diff --git a/TESTING/LIN/dgbt02.f b/TESTING/LIN/dgbt02.f index d6cde63b..819ea0e6 100644 --- a/TESTING/LIN/dgbt02.f +++ b/TESTING/LIN/dgbt02.f @@ -1,78 +1,159 @@ - SUBROUTINE DGBT02( TRANS, M, N, KL, KU, NRHS, A, LDA, X, LDX, B, - $ LDB, RESID ) -* -* -- LAPACK test routine (version 3.1) -- -* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd.. -* November 2006 -* -* .. Scalar Arguments .. - CHARACTER TRANS - INTEGER KL, KU, LDA, LDB, LDX, M, N, NRHS - DOUBLE PRECISION RESID -* .. -* .. Array Arguments .. - DOUBLE PRECISION A( LDA, * ), B( LDB, * ), X( LDX, * ) -* .. -* +*> \brief \b DGBT02 +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE DGBT02( TRANS, M, N, KL, KU, NRHS, A, LDA, X, LDX, B, +* LDB, RESID ) +* +* .. Scalar Arguments .. +* CHARACTER TRANS +* INTEGER KL, KU, LDA, LDB, LDX, M, N, NRHS +* DOUBLE PRECISION RESID +* .. +* .. Array Arguments .. +* DOUBLE PRECISION A( LDA, * ), B( LDB, * ), X( LDX, * ) +* .. +* * Purpose * ======= * -* DGBT02 computes the residual for a solution of a banded system of -* equations A*x = b or A'*x = b: -* RESID = norm( B - A*X ) / ( norm(A) * norm(X) * EPS). -* where EPS is the machine precision. +*>\details \b Purpose: +*>\verbatim +*> +*> DGBT02 computes the residual for a solution of a banded system of +*> equations A*x = b or A'*x = b: +*> RESID = norm( B - A*X ) / ( norm(A) * norm(X) * EPS). +*> where EPS is the machine precision. +*> +*>\endverbatim * * Arguments * ========= * -* TRANS (input) CHARACTER*1 -* Specifies the form of the system of equations: -* = 'N': A *x = b -* = 'T': A'*x = b, where A' is the transpose of A -* = 'C': A'*x = b, where A' is the transpose of A -* -* M (input) INTEGER -* The number of rows of the matrix A. M >= 0. -* -* N (input) INTEGER -* The number of columns of the matrix A. N >= 0. -* -* KL (input) INTEGER -* The number of subdiagonals within the band of A. KL >= 0. -* -* KU (input) INTEGER -* The number of superdiagonals within the band of A. KU >= 0. -* -* NRHS (input) INTEGER -* The number of columns of B. NRHS >= 0. -* -* A (input) DOUBLE PRECISION array, dimension (LDA,N) -* The original matrix A in band storage, stored in rows 1 to -* KL+KU+1. +*> \param[in] TRANS +*> \verbatim +*> TRANS is CHARACTER*1 +*> Specifies the form of the system of equations: +*> = 'N': A *x = b +*> = 'T': A'*x = b, where A' is the transpose of A +*> = 'C': A'*x = b, where A' is the transpose of A +*> \endverbatim +*> +*> \param[in] M +*> \verbatim +*> M is INTEGER +*> The number of rows of the matrix A. M >= 0. +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of columns of the matrix A. N >= 0. +*> \endverbatim +*> +*> \param[in] KL +*> \verbatim +*> KL is INTEGER +*> The number of subdiagonals within the band of A. KL >= 0. +*> \endverbatim +*> +*> \param[in] KU +*> \verbatim +*> KU is INTEGER +*> The number of superdiagonals within the band of A. KU >= 0. +*> \endverbatim +*> +*> \param[in] NRHS +*> \verbatim +*> NRHS is INTEGER +*> The number of columns of B. NRHS >= 0. +*> \endverbatim +*> +*> \param[in] A +*> \verbatim +*> A is DOUBLE PRECISION array, dimension (LDA,N) +*> The original matrix A in band storage, stored in rows 1 to +*> KL+KU+1. +*> \endverbatim +*> +*> \param[in] LDA +*> \verbatim +*> LDA is INTEGER +*> The leading dimension of the array A. LDA >= max(1,KL+KU+1). +*> \endverbatim +*> +*> \param[in] X +*> \verbatim +*> X is DOUBLE PRECISION array, dimension (LDX,NRHS) +*> The computed solution vectors for the system of linear +*> equations. +*> \endverbatim +*> +*> \param[in] LDX +*> \verbatim +*> LDX is INTEGER +*> The leading dimension of the array X. If TRANS = 'N', +*> LDX >= max(1,N); if TRANS = 'T' or 'C', LDX >= max(1,M). +*> \endverbatim +*> +*> \param[in,out] B +*> \verbatim +*> B is DOUBLE PRECISION array, dimension (LDB,NRHS) +*> On entry, the right hand side vectors for the system of +*> linear equations. +*> On exit, B is overwritten with the difference B - A*X. +*> \endverbatim +*> +*> \param[in] LDB +*> \verbatim +*> LDB is INTEGER +*> The leading dimension of the array B. IF TRANS = 'N', +*> LDB >= max(1,M); if TRANS = 'T' or 'C', LDB >= max(1,N). +*> \endverbatim +*> +*> \param[out] RESID +*> \verbatim +*> RESID is DOUBLE PRECISION +*> The maximum over the number of right hand sides of +*> norm(B - A*X) / ( norm(A) * norm(X) * EPS ). +*> \endverbatim +*> +* +* Authors +* ======= * -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(1,KL+KU+1). +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* X (input) DOUBLE PRECISION array, dimension (LDX,NRHS) -* The computed solution vectors for the system of linear -* equations. +*> \date November 2011 * -* LDX (input) INTEGER -* The leading dimension of the array X. If TRANS = 'N', -* LDX >= max(1,N); if TRANS = 'T' or 'C', LDX >= max(1,M). +*> \ingroup double_lin * -* B (input/output) DOUBLE PRECISION array, dimension (LDB,NRHS) -* On entry, the right hand side vectors for the system of -* linear equations. -* On exit, B is overwritten with the difference B - A*X. +* ===================================================================== + SUBROUTINE DGBT02( TRANS, M, N, KL, KU, NRHS, A, LDA, X, LDX, B, + $ LDB, RESID ) * -* LDB (input) INTEGER -* The leading dimension of the array B. IF TRANS = 'N', -* LDB >= max(1,M); if TRANS = 'T' or 'C', LDB >= max(1,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 -* The maximum over the number of right hand sides of -* norm(B - A*X) / ( norm(A) * norm(X) * EPS ). +* .. Scalar Arguments .. + CHARACTER TRANS + INTEGER KL, KU, LDA, LDB, LDX, M, N, NRHS + DOUBLE PRECISION RESID +* .. +* .. Array Arguments .. + DOUBLE PRECISION A( LDA, * ), B( LDB, * ), X( LDX, * ) +* .. * * ===================================================================== * -- cgit v1.2.3