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 /TESTING/LIN/ddrvgex.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) |
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/LIN/ddrvgex.f')
-rw-r--r-- | TESTING/LIN/ddrvgex.f | 236 |
1 files changed, 170 insertions, 66 deletions
diff --git a/TESTING/LIN/ddrvgex.f b/TESTING/LIN/ddrvgex.f index 17fe1f45..4eb3c1db 100644 --- a/TESTING/LIN/ddrvgex.f +++ b/TESTING/LIN/ddrvgex.f @@ -1,10 +1,178 @@ +*> \brief \b DDRVGEX +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE DDRVGE( DOTYPE, NN, NVAL, NRHS, THRESH, TSTERR, NMAX, +* A, AFAC, ASAV, B, BSAV, X, XACT, S, WORK, +* RWORK, IWORK, NOUT ) +* +* .. Scalar Arguments .. +* LOGICAL TSTERR +* INTEGER NMAX, NN, NOUT, NRHS +* DOUBLE PRECISION THRESH +* .. +* .. Array Arguments .. +* LOGICAL DOTYPE( * ) +* INTEGER IWORK( * ), NVAL( * ) +* DOUBLE PRECISION A( * ), AFAC( * ), ASAV( * ), B( * ), +* $ BSAV( * ), RWORK( * ), S( * ), WORK( * ), +* $ X( * ), XACT( * ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> DDRVGE tests the driver routines DGESV, -SVX, and -SVXX. +*> +*> Note that this file is used only when the XBLAS are available, +*> otherwise ddrvge.f defines this subroutine. +*> +*>\endverbatim +* +* Arguments +* ========= +* +*> \param[in] DOTYPE +*> \verbatim +*> DOTYPE is LOGICAL array, dimension (NTYPES) +*> The matrix types to be used for testing. Matrices of type j +*> (for 1 <= j <= NTYPES) are used for testing if DOTYPE(j) = +*> .TRUE.; if DOTYPE(j) = .FALSE., then type j is not used. +*> \endverbatim +*> +*> \param[in] NN +*> \verbatim +*> NN is INTEGER +*> The number of values of N contained in the vector NVAL. +*> \endverbatim +*> +*> \param[in] NVAL +*> \verbatim +*> NVAL is INTEGER array, dimension (NN) +*> The values of the matrix column dimension N. +*> \endverbatim +*> +*> \param[in] NRHS +*> \verbatim +*> NRHS is INTEGER +*> The number of right hand side vectors to be generated for +*> each linear system. +*> \endverbatim +*> +*> \param[in] THRESH +*> \verbatim +*> THRESH is DOUBLE PRECISION +*> The threshold value for the test ratios. A result is +*> included in the output file if RESULT >= THRESH. To have +*> every test ratio printed, use THRESH = 0. +*> \endverbatim +*> +*> \param[in] TSTERR +*> \verbatim +*> TSTERR is LOGICAL +*> Flag that indicates whether error exits are to be tested. +*> \endverbatim +*> +*> \param[in] NMAX +*> \verbatim +*> NMAX is INTEGER +*> The maximum value permitted for N, used in dimensioning the +*> work arrays. +*> \endverbatim +*> +*> \param[out] A +*> \verbatim +*> A is DOUBLE PRECISION array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] AFAC +*> \verbatim +*> AFAC is DOUBLE PRECISION array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] ASAV +*> \verbatim +*> ASAV is DOUBLE PRECISION array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] B +*> \verbatim +*> B is DOUBLE PRECISION array, dimension (NMAX*NRHS) +*> \endverbatim +*> +*> \param[out] BSAV +*> \verbatim +*> BSAV is DOUBLE PRECISION array, dimension (NMAX*NRHS) +*> \endverbatim +*> +*> \param[out] X +*> \verbatim +*> X is DOUBLE PRECISION array, dimension (NMAX*NRHS) +*> \endverbatim +*> +*> \param[out] XACT +*> \verbatim +*> XACT is DOUBLE PRECISION array, dimension (NMAX*NRHS) +*> \endverbatim +*> +*> \param[out] S +*> \verbatim +*> S is DOUBLE PRECISION array, dimension (2*NMAX) +*> \endverbatim +*> +*> \param[out] WORK +*> \verbatim +*> WORK is DOUBLE PRECISION array, dimension +*> (NMAX*max(3,NRHS)) +*> \endverbatim +*> +*> \param[out] RWORK +*> \verbatim +*> RWORK is DOUBLE PRECISION array, dimension (2*NRHS+NMAX) +*> \endverbatim +*> +*> \param[out] IWORK +*> \verbatim +*> IWORK is INTEGER array, dimension (2*NMAX) +*> \endverbatim +*> +*> \param[in] NOUT +*> \verbatim +*> NOUT is INTEGER +*> The unit number for output. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. +* +*> \date November 2011 +* +*> \ingroup double_lin +* +* ===================================================================== SUBROUTINE DDRVGE( DOTYPE, NN, NVAL, NRHS, THRESH, TSTERR, NMAX, $ A, AFAC, ASAV, B, BSAV, X, XACT, S, WORK, $ RWORK, IWORK, NOUT ) * * -- LAPACK test routine (version 3.2.1) -- -* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd.. -* April 2009 +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 * * .. Scalar Arguments .. LOGICAL TSTERR @@ -19,70 +187,6 @@ $ X( * ), XACT( * ) * .. * -* Purpose -* ======= -* -* DDRVGE tests the driver routines DGESV, -SVX, and -SVXX. -* -* Note that this file is used only when the XBLAS are available, -* otherwise ddrvge.f defines this subroutine. -* -* Arguments -* ========= -* -* DOTYPE (input) LOGICAL array, dimension (NTYPES) -* The matrix types to be used for testing. Matrices of type j -* (for 1 <= j <= NTYPES) are used for testing if DOTYPE(j) = -* .TRUE.; if DOTYPE(j) = .FALSE., then type j is not used. -* -* NN (input) INTEGER -* The number of values of N contained in the vector NVAL. -* -* NVAL (input) INTEGER array, dimension (NN) -* The values of the matrix column dimension N. -* -* NRHS (input) INTEGER -* The number of right hand side vectors to be generated for -* each linear system. -* -* THRESH (input) DOUBLE PRECISION -* The threshold value for the test ratios. A result is -* included in the output file if RESULT >= THRESH. To have -* every test ratio printed, use THRESH = 0. -* -* TSTERR (input) LOGICAL -* Flag that indicates whether error exits are to be tested. -* -* NMAX (input) INTEGER -* The maximum value permitted for N, used in dimensioning the -* work arrays. -* -* A (workspace) DOUBLE PRECISION array, dimension (NMAX*NMAX) -* -* AFAC (workspace) DOUBLE PRECISION array, dimension (NMAX*NMAX) -* -* ASAV (workspace) DOUBLE PRECISION array, dimension (NMAX*NMAX) -* -* B (workspace) DOUBLE PRECISION array, dimension (NMAX*NRHS) -* -* BSAV (workspace) DOUBLE PRECISION array, dimension (NMAX*NRHS) -* -* X (workspace) DOUBLE PRECISION array, dimension (NMAX*NRHS) -* -* XACT (workspace) DOUBLE PRECISION array, dimension (NMAX*NRHS) -* -* S (workspace) DOUBLE PRECISION array, dimension (2*NMAX) -* -* WORK (workspace) DOUBLE PRECISION array, dimension -* (NMAX*max(3,NRHS)) -* -* RWORK (workspace) DOUBLE PRECISION array, dimension (2*NRHS+NMAX) -* -* IWORK (workspace) INTEGER array, dimension (2*NMAX) -* -* NOUT (input) INTEGER -* The unit number for output. -* * ===================================================================== * * .. Parameters .. |