summaryrefslogtreecommitdiff
path: root/TESTING/LIN/zlatb4.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/zlatb4.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/LIN/zlatb4.f')
-rw-r--r--TESTING/LIN/zlatb4.f171
1 files changed, 122 insertions, 49 deletions
diff --git a/TESTING/LIN/zlatb4.f b/TESTING/LIN/zlatb4.f
index 0440ce46..c8aade08 100644
--- a/TESTING/LIN/zlatb4.f
+++ b/TESTING/LIN/zlatb4.f
@@ -1,65 +1,138 @@
- SUBROUTINE ZLATB4( PATH, IMAT, M, N, TYPE, KL, KU, ANORM, MODE,
- $ CNDNUM, DIST )
-*
-* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
-*
-* .. Scalar Arguments ..
- CHARACTER DIST, TYPE
- CHARACTER*3 PATH
- INTEGER IMAT, KL, KU, M, MODE, N
- DOUBLE PRECISION ANORM, CNDNUM
-* ..
-*
+*> \brief \b ZLATB4
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE ZLATB4( PATH, IMAT, M, N, TYPE, KL, KU, ANORM, MODE,
+* CNDNUM, DIST )
+*
+* .. Scalar Arguments ..
+* CHARACTER DIST, TYPE
+* CHARACTER*3 PATH
+* INTEGER IMAT, KL, KU, M, MODE, N
+* DOUBLE PRECISION ANORM, CNDNUM
+* ..
+*
* Purpose
* =======
*
-* ZLATB4 sets parameters for the matrix generator based on the type of
-* matrix to be generated.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZLATB4 sets parameters for the matrix generator based on the type of
+*> matrix to be generated.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* PATH (input) CHARACTER*3
-* The LAPACK path name.
-*
-* IMAT (input) INTEGER
-* An integer key describing which matrix to generate for this
-* path.
-*
-* M (input) INTEGER
-* The number of rows in the matrix to be generated.
-*
-* N (input) INTEGER
-* The number of columns in the matrix to be generated.
-*
-* TYPE (output) CHARACTER*1
-* The type of the matrix to be generated:
-* = 'S': symmetric matrix
-* = 'P': symmetric positive (semi)definite matrix
-* = 'N': nonsymmetric matrix
+*> \param[in] PATH
+*> \verbatim
+*> PATH is CHARACTER*3
+*> The LAPACK path name.
+*> \endverbatim
+*>
+*> \param[in] IMAT
+*> \verbatim
+*> IMAT is INTEGER
+*> An integer key describing which matrix to generate for this
+*> path.
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*> M is INTEGER
+*> The number of rows in the matrix to be generated.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of columns in the matrix to be generated.
+*> \endverbatim
+*>
+*> \param[out] TYPE
+*> \verbatim
+*> TYPE is CHARACTER*1
+*> The type of the matrix to be generated:
+*> = 'S': symmetric matrix
+*> = 'P': symmetric positive (semi)definite matrix
+*> = 'N': nonsymmetric matrix
+*> \endverbatim
+*>
+*> \param[out] KL
+*> \verbatim
+*> KL is INTEGER
+*> The lower band width of the matrix to be generated.
+*> \endverbatim
+*>
+*> \param[out] KU
+*> \verbatim
+*> KU is INTEGER
+*> The upper band width of the matrix to be generated.
+*> \endverbatim
+*>
+*> \param[out] ANORM
+*> \verbatim
+*> ANORM is DOUBLE PRECISION
+*> The desired norm of the matrix to be generated. The diagonal
+*> matrix of singular values or eigenvalues is scaled by this
+*> value.
+*> \endverbatim
+*>
+*> \param[out] MODE
+*> \verbatim
+*> MODE is INTEGER
+*> A key indicating how to choose the vector of eigenvalues.
+*> \endverbatim
+*>
+*> \param[out] CNDNUM
+*> \verbatim
+*> CNDNUM is DOUBLE PRECISION
+*> The desired condition number.
+*> \endverbatim
+*>
+*> \param[out] DIST
+*> \verbatim
+*> DIST is CHARACTER*1
+*> The type of distribution to be used by the random number
+*> generator.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* KL (output) INTEGER
-* The lower band width of the matrix to be generated.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* KU (output) INTEGER
-* The upper band width of the matrix to be generated.
+*> \date November 2011
*
-* ANORM (output) DOUBLE PRECISION
-* The desired norm of the matrix to be generated. The diagonal
-* matrix of singular values or eigenvalues is scaled by this
-* value.
+*> \ingroup complex16_lin
*
-* MODE (output) INTEGER
-* A key indicating how to choose the vector of eigenvalues.
+* =====================================================================
+ SUBROUTINE ZLATB4( PATH, IMAT, M, N, TYPE, KL, KU, ANORM, MODE,
+ $ CNDNUM, DIST )
*
-* CNDNUM (output) DOUBLE PRECISION
-* The desired condition 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
*
-* DIST (output) CHARACTER*1
-* The type of distribution to be used by the random number
-* generator.
+* .. Scalar Arguments ..
+ CHARACTER DIST, TYPE
+ CHARACTER*3 PATH
+ INTEGER IMAT, KL, KU, M, MODE, N
+ DOUBLE PRECISION ANORM, CNDNUM
+* ..
*
* =====================================================================
*