aboutsummaryrefslogtreecommitdiff
path: root/SRC/zla_syrcond_c.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/zla_syrcond_c.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
Integrating Doxygen in comments
Diffstat (limited to 'SRC/zla_syrcond_c.f')
-rw-r--r--SRC/zla_syrcond_c.f193
1 files changed, 134 insertions, 59 deletions
diff --git a/SRC/zla_syrcond_c.f b/SRC/zla_syrcond_c.f
index 42ef9db3..c4887d64 100644
--- a/SRC/zla_syrcond_c.f
+++ b/SRC/zla_syrcond_c.f
@@ -1,17 +1,142 @@
+*> \brief \b ZLA_SYRCOND_C
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* DOUBLE PRECISION FUNCTION ZLA_SYRCOND_C( UPLO, N, A, LDA, AF,
+* LDAF, IPIV, C, CAPPLY,
+* INFO, WORK, RWORK )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* LOGICAL CAPPLY
+* INTEGER N, LDA, LDAF, INFO
+* ..
+* .. Array Arguments ..
+* INTEGER IPIV( * )
+* COMPLEX*16 A( LDA, * ), AF( LDAF, * ), WORK( * )
+* DOUBLE PRECISION C( * ), RWORK( * )
+* ..
+*
+* Purpose
+* =======
+*
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZLA_SYRCOND_C Computes the infinity norm condition number of
+*> op(A) * inv(diag(C)) where C is a DOUBLE PRECISION vector.
+*>
+*>\endverbatim
+*
+* Arguments
+* =========
+*
+*> \param[in] UPLO
+*> \verbatim
+*> UPLO is CHARACTER*1
+*> = 'U': Upper triangle of A is stored;
+*> = 'L': Lower triangle of A is stored.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of linear equations, i.e., the order of the
+*> matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is COMPLEX*16 array, dimension (LDA,N)
+*> On entry, the N-by-N matrix A
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] AF
+*> \verbatim
+*> AF is COMPLEX*16 array, dimension (LDAF,N)
+*> The block diagonal matrix D and the multipliers used to
+*> obtain the factor U or L as computed by ZSYTRF.
+*> \endverbatim
+*>
+*> \param[in] LDAF
+*> \verbatim
+*> LDAF is INTEGER
+*> The leading dimension of the array AF. LDAF >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] IPIV
+*> \verbatim
+*> IPIV is INTEGER array, dimension (N)
+*> Details of the interchanges and the block structure of D
+*> as determined by ZSYTRF.
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*> C is DOUBLE PRECISION array, dimension (N)
+*> The vector C in the formula op(A) * inv(diag(C)).
+*> \endverbatim
+*>
+*> \param[in] CAPPLY
+*> \verbatim
+*> CAPPLY is LOGICAL
+*> If .TRUE. then access the vector C in the formula above.
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
+*> = 0: Successful exit.
+*> i > 0: The ith argument is invalid.
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*> WORK is COMPLEX*16 array, dimension (2*N).
+*> Workspace.
+*> \endverbatim
+*>
+*> \param[in] RWORK
+*> \verbatim
+*> RWORK is DOUBLE PRECISION array, dimension (N).
+*> Workspace.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup complex16SYcomputational
+*
+* =====================================================================
DOUBLE PRECISION FUNCTION ZLA_SYRCOND_C( UPLO, N, A, LDA, AF,
$ LDAF, IPIV, C, CAPPLY,
$ INFO, WORK, RWORK )
*
-* -- LAPACK routine (version 3.2.1) --
-* -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-* -- Jason Riedy of Univ. of California Berkeley. --
-* -- April 2009 --
+* -- LAPACK computational routine (version 3.2.1) --
+* -- LAPACK is a software package provided by Univ. of Tennessee, --
+* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+* November 2011
*
-* -- LAPACK is a software package provided by Univ. of Tennessee, --
-* -- Univ. of California Berkeley and NAG Ltd. --
-*
- IMPLICIT NONE
-* ..
* .. Scalar Arguments ..
CHARACTER UPLO
LOGICAL CAPPLY
@@ -23,56 +148,6 @@
DOUBLE PRECISION C( * ), RWORK( * )
* ..
*
-* Purpose
-* =======
-*
-* ZLA_SYRCOND_C Computes the infinity norm condition number of
-* op(A) * inv(diag(C)) where C is a DOUBLE PRECISION vector.
-*
-* Arguments
-* =========
-*
-* UPLO (input) CHARACTER*1
-* = 'U': Upper triangle of A is stored;
-* = 'L': Lower triangle of A is stored.
-*
-* N (input) INTEGER
-* The number of linear equations, i.e., the order of the
-* matrix A. N >= 0.
-*
-* A (input) COMPLEX*16 array, dimension (LDA,N)
-* On entry, the N-by-N matrix A
-*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,N).
-*
-* AF (input) COMPLEX*16 array, dimension (LDAF,N)
-* The block diagonal matrix D and the multipliers used to
-* obtain the factor U or L as computed by ZSYTRF.
-*
-* LDAF (input) INTEGER
-* The leading dimension of the array AF. LDAF >= max(1,N).
-*
-* IPIV (input) INTEGER array, dimension (N)
-* Details of the interchanges and the block structure of D
-* as determined by ZSYTRF.
-*
-* C (input) DOUBLE PRECISION array, dimension (N)
-* The vector C in the formula op(A) * inv(diag(C)).
-*
-* CAPPLY (input) LOGICAL
-* If .TRUE. then access the vector C in the formula above.
-*
-* INFO (output) INTEGER
-* = 0: Successful exit.
-* i > 0: The ith argument is invalid.
-*
-* WORK (input) COMPLEX*16 array, dimension (2*N).
-* Workspace.
-*
-* RWORK (input) DOUBLE PRECISION array, dimension (N).
-* Workspace.
-*
* =====================================================================
*
* .. Local Scalars ..