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/schksy.f | 244 ++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 175 insertions(+), 69 deletions(-) (limited to 'TESTING/LIN/schksy.f') diff --git a/TESTING/LIN/schksy.f b/TESTING/LIN/schksy.f index d6a23ba8..6c6abcac 100644 --- a/TESTING/LIN/schksy.f +++ b/TESTING/LIN/schksy.f @@ -1,10 +1,183 @@ +*> \brief \b SCHKSY +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE SCHKSY( DOTYPE, NN, NVAL, NNB, NBVAL, NNS, NSVAL, +* THRESH, TSTERR, NMAX, A, AFAC, AINV, B, X, +* XACT, WORK, RWORK, IWORK, NOUT ) +* +* .. Scalar Arguments .. +* LOGICAL TSTERR +* INTEGER NMAX, NN, NNB, NNS, NOUT +* REAL THRESH +* .. +* .. Array Arguments .. +* LOGICAL DOTYPE( * ) +* INTEGER IWORK( * ), NBVAL( * ), NSVAL( * ), NVAL( * ) +* REAL A( * ), AFAC( * ), AINV( * ), B( * ), +* $ RWORK( * ), WORK( * ), X( * ), XACT( * ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> SCHKSY tests SSYTRF, -TRI2, -TRS, -TRS2, -RFS, and -CON. +*> +*>\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 dimension N. +*> \endverbatim +*> +*> \param[in] NNB +*> \verbatim +*> NNB is INTEGER +*> The number of values of NB contained in the vector NBVAL. +*> \endverbatim +*> +*> \param[in] NBVAL +*> \verbatim +*> NBVAL is INTEGER array, dimension (NBVAL) +*> The values of the blocksize NB. +*> \endverbatim +*> +*> \param[in] NNS +*> \verbatim +*> NNS is INTEGER +*> The number of values of NRHS contained in the vector NSVAL. +*> \endverbatim +*> +*> \param[in] NSVAL +*> \verbatim +*> NSVAL is INTEGER array, dimension (NNS) +*> The values of the number of right hand sides NRHS. +*> \endverbatim +*> +*> \param[in] THRESH +*> \verbatim +*> THRESH is REAL +*> 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 REAL array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] AFAC +*> \verbatim +*> AFAC is REAL array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] AINV +*> \verbatim +*> AINV is REAL array, dimension (NMAX*NMAX) +*> \endverbatim +*> +*> \param[out] B +*> \verbatim +*> B is REAL array, dimension (NMAX*NSMAX) +*> where NSMAX is the largest entry in NSVAL. +*> \endverbatim +*> +*> \param[out] X +*> \verbatim +*> X is REAL array, dimension (NMAX*NSMAX) +*> \endverbatim +*> +*> \param[out] XACT +*> \verbatim +*> XACT is REAL array, dimension (NMAX*NSMAX) +*> \endverbatim +*> +*> \param[out] WORK +*> \verbatim +*> WORK is REAL array, dimension +*> (NMAX*max(3,NSMAX)) +*> \endverbatim +*> +*> \param[out] RWORK +*> \verbatim +*> RWORK is REAL array, dimension +*> (max(NMAX,2*NSMAX)) +*> \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 single_lin +* +* ===================================================================== SUBROUTINE SCHKSY( DOTYPE, NN, NVAL, NNB, NBVAL, NNS, NSVAL, $ THRESH, TSTERR, NMAX, A, AFAC, AINV, B, X, $ XACT, WORK, RWORK, IWORK, NOUT ) * * -- LAPACK test routine (version 3.3.0) -- -* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd.. -* November 2010 +* -- 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 @@ -18,73 +191,6 @@ $ RWORK( * ), WORK( * ), X( * ), XACT( * ) * .. * -* Purpose -* ======= -* -* SCHKSY tests SSYTRF, -TRI2, -TRS, -TRS2, -RFS, and -CON. -* -* 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 dimension N. -* -* NNB (input) INTEGER -* The number of values of NB contained in the vector NBVAL. -* -* NBVAL (input) INTEGER array, dimension (NBVAL) -* The values of the blocksize NB. -* -* NNS (input) INTEGER -* The number of values of NRHS contained in the vector NSVAL. -* -* NSVAL (input) INTEGER array, dimension (NNS) -* The values of the number of right hand sides NRHS. -* -* THRESH (input) REAL -* 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) REAL array, dimension (NMAX*NMAX) -* -* AFAC (workspace) REAL array, dimension (NMAX*NMAX) -* -* AINV (workspace) REAL array, dimension (NMAX*NMAX) -* -* B (workspace) REAL array, dimension (NMAX*NSMAX) -* where NSMAX is the largest entry in NSVAL. -* -* X (workspace) REAL array, dimension (NMAX*NSMAX) -* -* XACT (workspace) REAL array, dimension (NMAX*NSMAX) -* -* WORK (workspace) REAL array, dimension -* (NMAX*max(3,NSMAX)) -* -* RWORK (workspace) REAL array, dimension -* (max(NMAX,2*NSMAX)) -* -* IWORK (workspace) INTEGER array, dimension (2*NMAX) -* -* NOUT (input) INTEGER -* The unit number for output. -* * ===================================================================== * * .. Parameters .. -- cgit v1.2.3