aboutsummaryrefslogtreecommitdiff
path: root/SRC/clange.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 /SRC/clange.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
Integrating Doxygen in comments
Diffstat (limited to 'SRC/clange.f')
-rw-r--r--SRC/clange.f160
1 files changed, 109 insertions, 51 deletions
diff --git a/SRC/clange.f b/SRC/clange.f
index 66779867..b04ab6b9 100644
--- a/SRC/clange.f
+++ b/SRC/clange.f
@@ -1,9 +1,117 @@
+*> \brief \b CLANGE
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* REAL FUNCTION CLANGE( NORM, M, N, A, LDA, WORK )
+*
+* .. Scalar Arguments ..
+* CHARACTER NORM
+* INTEGER LDA, M, N
+* ..
+* .. Array Arguments ..
+* REAL WORK( * )
+* COMPLEX A( LDA, * )
+* ..
+*
+* Purpose
+* =======
+*
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLANGE returns the value of the one norm, or the Frobenius norm, or
+*> the infinity norm, or the element of largest absolute value of a
+*> complex matrix A.
+*>
+*> Description
+*> ===========
+*>
+*> CLANGE returns the value
+*>
+*> CLANGE = ( max(abs(A(i,j))), NORM = 'M' or 'm'
+*> (
+*> ( norm1(A), NORM = '1', 'O' or 'o'
+*> (
+*> ( normI(A), NORM = 'I' or 'i'
+*> (
+*> ( normF(A), NORM = 'F', 'f', 'E' or 'e'
+*>
+*> where norm1 denotes the one norm of a matrix (maximum column sum),
+*> normI denotes the infinity norm of a matrix (maximum row sum) and
+*> normF denotes the Frobenius norm of a matrix (square root of sum of
+*> squares). Note that max(abs(A(i,j))) is not a consistent matrix norm.
+*>
+*>\endverbatim
+*
+* Arguments
+* =========
+*
+*> \param[in] NORM
+*> \verbatim
+*> NORM is CHARACTER*1
+*> Specifies the value to be returned in CLANGE as described
+*> above.
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*> M is INTEGER
+*> The number of rows of the matrix A. M >= 0. When M = 0,
+*> CLANGE is set to zero.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of columns of the matrix A. N >= 0. When N = 0,
+*> CLANGE is set to zero.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is COMPLEX array, dimension (LDA,N)
+*> The m by n matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(M,1).
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*> WORK is REAL array, dimension (MAX(1,LWORK)),
+*> where LWORK >= M when NORM = 'I'; otherwise, WORK is not
+*> referenced.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup complexGEauxiliary
+*
+* =====================================================================
REAL FUNCTION CLANGE( NORM, M, N, A, LDA, WORK )
*
* -- LAPACK auxiliary routine (version 3.2) --
* -- LAPACK is a software package provided by Univ. of Tennessee, --
* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-* November 2006
+* November 2011
*
* .. Scalar Arguments ..
CHARACTER NORM
@@ -14,56 +122,6 @@
COMPLEX A( LDA, * )
* ..
*
-* Purpose
-* =======
-*
-* CLANGE returns the value of the one norm, or the Frobenius norm, or
-* the infinity norm, or the element of largest absolute value of a
-* complex matrix A.
-*
-* Description
-* ===========
-*
-* CLANGE returns the value
-*
-* CLANGE = ( max(abs(A(i,j))), NORM = 'M' or 'm'
-* (
-* ( norm1(A), NORM = '1', 'O' or 'o'
-* (
-* ( normI(A), NORM = 'I' or 'i'
-* (
-* ( normF(A), NORM = 'F', 'f', 'E' or 'e'
-*
-* where norm1 denotes the one norm of a matrix (maximum column sum),
-* normI denotes the infinity norm of a matrix (maximum row sum) and
-* normF denotes the Frobenius norm of a matrix (square root of sum of
-* squares). Note that max(abs(A(i,j))) is not a consistent matrix norm.
-*
-* Arguments
-* =========
-*
-* NORM (input) CHARACTER*1
-* Specifies the value to be returned in CLANGE as described
-* above.
-*
-* M (input) INTEGER
-* The number of rows of the matrix A. M >= 0. When M = 0,
-* CLANGE is set to zero.
-*
-* N (input) INTEGER
-* The number of columns of the matrix A. N >= 0. When N = 0,
-* CLANGE is set to zero.
-*
-* A (input) COMPLEX array, dimension (LDA,N)
-* The m by n matrix A.
-*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(M,1).
-*
-* WORK (workspace) REAL array, dimension (MAX(1,LWORK)),
-* where LWORK >= M when NORM = 'I'; otherwise, WORK is not
-* referenced.
-*
* =====================================================================
*
* .. Parameters ..