summaryrefslogtreecommitdiff
path: root/TESTING/EIG/cget35.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/EIG/cget35.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/EIG/cget35.f')
-rw-r--r--TESTING/EIG/cget35.f116
1 files changed, 84 insertions, 32 deletions
diff --git a/TESTING/EIG/cget35.f b/TESTING/EIG/cget35.f
index e227c9dc..c1cde658 100644
--- a/TESTING/EIG/cget35.f
+++ b/TESTING/EIG/cget35.f
@@ -1,48 +1,100 @@
- SUBROUTINE CGET35( RMAX, LMAX, NINFO, KNT, NIN )
+*> \brief \b CGET35
*
-* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
+* =========== DOCUMENTATION ===========
*
-* .. Scalar Arguments ..
- INTEGER KNT, LMAX, NIN, NINFO
- REAL RMAX
-* ..
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
*
+* Definition
+* ==========
+*
+* SUBROUTINE CGET35( RMAX, LMAX, NINFO, KNT, NIN )
+*
+* .. Scalar Arguments ..
+* INTEGER KNT, LMAX, NIN, NINFO
+* REAL RMAX
+* ..
+*
* Purpose
* =======
*
-* CGET35 tests CTRSYL, a routine for solving the Sylvester matrix
-* equation
-*
-* op(A)*X + ISGN*X*op(B) = scale*C,
-*
-* A and B are assumed to be in Schur canonical form, op() represents an
-* optional transpose, and ISGN can be -1 or +1. Scale is an output
-* less than or equal to 1, chosen to avoid overflow in X.
-*
-* The test code verifies that the following residual is order 1:
-*
-* norm(op(A)*X + ISGN*X*op(B) - scale*C) /
-* (EPS*max(norm(A),norm(B))*norm(X))
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CGET35 tests CTRSYL, a routine for solving the Sylvester matrix
+*> equation
+*>
+*> op(A)*X + ISGN*X*op(B) = scale*C,
+*>
+*> A and B are assumed to be in Schur canonical form, op() represents an
+*> optional transpose, and ISGN can be -1 or +1. Scale is an output
+*> less than or equal to 1, chosen to avoid overflow in X.
+*>
+*> The test code verifies that the following residual is order 1:
+*>
+*> norm(op(A)*X + ISGN*X*op(B) - scale*C) /
+*> (EPS*max(norm(A),norm(B))*norm(X))
+*>
+*>\endverbatim
*
* Arguments
-* ==========
+* =========
+*
+*> \param[out] RMAX
+*> \verbatim
+*> RMAX is REAL
+*> Value of the largest test ratio.
+*> \endverbatim
+*>
+*> \param[out] LMAX
+*> \verbatim
+*> LMAX is INTEGER
+*> Example number where largest test ratio achieved.
+*> \endverbatim
+*>
+*> \param[out] NINFO
+*> \verbatim
+*> NINFO is INTEGER
+*> Number of examples where INFO is nonzero.
+*> \endverbatim
+*>
+*> \param[out] KNT
+*> \verbatim
+*> KNT is INTEGER
+*> Total number of examples tested.
+*> \endverbatim
+*>
+*> \param[in] NIN
+*> \verbatim
+*> NIN is INTEGER
+*> Input logical unit number.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* RMAX (output) REAL
-* Value of the largest test ratio.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* LMAX (output) INTEGER
-* Example number where largest test ratio achieved.
+*> \date November 2011
*
-* NINFO (output) INTEGER
-* Number of examples where INFO is nonzero.
+*> \ingroup complex_eig
*
-* KNT (output) INTEGER
-* Total number of examples tested.
+* =====================================================================
+ SUBROUTINE CGET35( RMAX, LMAX, NINFO, KNT, NIN )
*
-* NIN (input) INTEGER
-* Input logical unit number.
+* -- 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
+*
+* .. Scalar Arguments ..
+ INTEGER KNT, LMAX, NIN, NINFO
+ REAL RMAX
+* ..
*
* =====================================================================
*