summaryrefslogtreecommitdiff
path: root/TESTING/EIG/slctes.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/slctes.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/EIG/slctes.f')
-rw-r--r--TESTING/EIG/slctes.f91
1 files changed, 68 insertions, 23 deletions
diff --git a/TESTING/EIG/slctes.f b/TESTING/EIG/slctes.f
index d5288e2d..44ecb89f 100644
--- a/TESTING/EIG/slctes.f
+++ b/TESTING/EIG/slctes.f
@@ -1,38 +1,83 @@
- LOGICAL FUNCTION SLCTES( ZR, ZI, D )
+*> \brief \b SLCTES
*
-* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
+* =========== DOCUMENTATION ===========
*
-* .. Scalar Arguments ..
- REAL D, ZI, ZR
-* ..
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
*
+* Definition
+* ==========
+*
+* LOGICAL FUNCTION SLCTES( ZR, ZI, D )
+*
+* .. Scalar Arguments ..
+* REAL D, ZI, ZR
+* ..
+*
* Purpose
* =======
*
-* SLCTES returns .TRUE. if the eigenvalue (ZR/D) + sqrt(-1)*(ZI/D)
-* is to be selected (specifically, in this subroutine, if the real
-* part of the eigenvalue is negative), and otherwise it returns
-* .FALSE..
-*
-* It is used by the test routine SDRGES to test whether the driver
-* routine SGGES succesfully sorts eigenvalues.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SLCTES returns .TRUE. if the eigenvalue (ZR/D) + sqrt(-1)*(ZI/D)
+*> is to be selected (specifically, in this subroutine, if the real
+*> part of the eigenvalue is negative), and otherwise it returns
+*> .FALSE..
+*>
+*> It is used by the test routine SDRGES to test whether the driver
+*> routine SGGES succesfully sorts eigenvalues.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* ZR (input) REAL
-* The numerator of the real part of a complex eigenvalue
-* (ZR/D) + i*(ZI/D).
+*> \param[in] ZR
+*> \verbatim
+*> ZR is REAL
+*> The numerator of the real part of a complex eigenvalue
+*> (ZR/D) + i*(ZI/D).
+*> \endverbatim
+*>
+*> \param[in] ZI
+*> \verbatim
+*> ZI is REAL
+*> The numerator of the imaginary part of a complex eigenvalue
+*> (ZR/D) + i*(ZI).
+*> \endverbatim
+*>
+*> \param[in] D
+*> \verbatim
+*> D is REAL
+*> The denominator part of a complex eigenvalue
+*> (ZR/D) + i*(ZI/D).
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* ZI (input) REAL
-* The numerator of the imaginary part of a complex eigenvalue
-* (ZR/D) + i*(ZI).
+*> \date November 2011
*
-* D (input) REAL
-* The denominator part of a complex eigenvalue
-* (ZR/D) + i*(ZI/D).
+*> \ingroup single_eig
+*
+* =====================================================================
+ LOGICAL FUNCTION SLCTES( ZR, ZI, D )
+*
+* -- 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 ..
+ REAL D, ZI, ZR
+* ..
*
* =====================================================================
*