aboutsummaryrefslogtreecommitdiff
path: root/TESTING/LIN/sget03.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/sget03.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/LIN/sget03.f')
-rw-r--r--TESTING/LIN/sget03.f152
1 files changed, 112 insertions, 40 deletions
diff --git a/TESTING/LIN/sget03.f b/TESTING/LIN/sget03.f
index 19798d28..27d0efe8 100644
--- a/TESTING/LIN/sget03.f
+++ b/TESTING/LIN/sget03.f
@@ -1,57 +1,129 @@
- SUBROUTINE SGET03( N, A, LDA, AINV, LDAINV, WORK, LDWORK, RWORK,
- $ RCOND, RESID )
+*> \brief \b SGET03
*
-* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
+* =========== DOCUMENTATION ===========
*
-* .. Scalar Arguments ..
- INTEGER LDA, LDAINV, LDWORK, N
- REAL RCOND, RESID
-* ..
-* .. Array Arguments ..
- REAL A( LDA, * ), AINV( LDAINV, * ), RWORK( * ),
- $ WORK( LDWORK, * )
-* ..
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
*
+* SUBROUTINE SGET03( N, A, LDA, AINV, LDAINV, WORK, LDWORK, RWORK,
+* RCOND, RESID )
+*
+* .. Scalar Arguments ..
+* INTEGER LDA, LDAINV, LDWORK, N
+* REAL RCOND, RESID
+* ..
+* .. Array Arguments ..
+* REAL A( LDA, * ), AINV( LDAINV, * ), RWORK( * ),
+* $ WORK( LDWORK, * )
+* ..
+*
* Purpose
* =======
*
-* SGET03 computes the residual for a general matrix times its inverse:
-* norm( I - AINV*A ) / ( N * norm(A) * norm(AINV) * EPS ),
-* where EPS is the machine epsilon.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SGET03 computes the residual for a general matrix times its inverse:
+*> norm( I - AINV*A ) / ( N * norm(A) * norm(AINV) * EPS ),
+*> where EPS is the machine epsilon.
+*>
+*>\endverbatim
*
* Arguments
-* ==========
-*
-* N (input) INTEGER
-* The number of rows and columns of the matrix A. N >= 0.
-*
-* A (input) REAL array, dimension (LDA,N)
-* The original N x N matrix A.
-*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,N).
-*
-* AINV (input) REAL array, dimension (LDAINV,N)
-* The inverse of the matrix A.
+* =========
+*
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of rows and columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is REAL array, dimension (LDA,N)
+*> The original N x N matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] AINV
+*> \verbatim
+*> AINV is REAL array, dimension (LDAINV,N)
+*> The inverse of the matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDAINV
+*> \verbatim
+*> LDAINV is INTEGER
+*> The leading dimension of the array AINV. LDAINV >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*> WORK is REAL array, dimension (LDWORK,N)
+*> \endverbatim
+*>
+*> \param[in] LDWORK
+*> \verbatim
+*> LDWORK is INTEGER
+*> The leading dimension of the array WORK. LDWORK >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] RWORK
+*> \verbatim
+*> RWORK is REAL array, dimension (N)
+*> \endverbatim
+*>
+*> \param[out] RCOND
+*> \verbatim
+*> RCOND is REAL
+*> The reciprocal of the condition number of A, computed as
+*> ( 1/norm(A) ) / norm(AINV).
+*> \endverbatim
+*>
+*> \param[out] RESID
+*> \verbatim
+*> RESID is REAL
+*> norm(I - AINV*A) / ( N * norm(A) * norm(AINV) * EPS )
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* LDAINV (input) INTEGER
-* The leading dimension of the array AINV. LDAINV >= max(1,N).
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* WORK (workspace) REAL array, dimension (LDWORK,N)
+*> \date November 2011
*
-* LDWORK (input) INTEGER
-* The leading dimension of the array WORK. LDWORK >= max(1,N).
+*> \ingroup single_lin
*
-* RWORK (workspace) REAL array, dimension (N)
+* =====================================================================
+ SUBROUTINE SGET03( N, A, LDA, AINV, LDAINV, WORK, LDWORK, RWORK,
+ $ RCOND, RESID )
*
-* RCOND (output) REAL
-* The reciprocal of the condition number of A, computed as
-* ( 1/norm(A) ) / norm(AINV).
+* -- 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) REAL
-* norm(I - AINV*A) / ( N * norm(A) * norm(AINV) * EPS )
+* .. Scalar Arguments ..
+ INTEGER LDA, LDAINV, LDWORK, N
+ REAL RCOND, RESID
+* ..
+* .. Array Arguments ..
+ REAL A( LDA, * ), AINV( LDAINV, * ), RWORK( * ),
+ $ WORK( LDWORK, * )
+* ..
*
* =====================================================================
*