summaryrefslogtreecommitdiff
path: root/TESTING/LIN/zpot02.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/zpot02.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'TESTING/LIN/zpot02.f')
-rw-r--r--TESTING/LIN/zpot02.f186
1 files changed, 131 insertions, 55 deletions
diff --git a/TESTING/LIN/zpot02.f b/TESTING/LIN/zpot02.f
index 321ffba8..0ed93473 100644
--- a/TESTING/LIN/zpot02.f
+++ b/TESTING/LIN/zpot02.f
@@ -1,9 +1,138 @@
+*> \brief \b ZPOT02
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE ZPOT02( UPLO, N, NRHS, A, LDA, X, LDX, B, LDB, RWORK,
+* RESID )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER LDA, LDB, LDX, N, NRHS
+* DOUBLE PRECISION RESID
+* ..
+* .. Array Arguments ..
+* DOUBLE PRECISION RWORK( * )
+* COMPLEX*16 A( LDA, * ), B( LDB, * ), X( LDX, * )
+* ..
+*
+* Purpose
+* =======
+*
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZPOT02 computes the residual for the solution of a Hermitian system
+*> of linear equations A*x = b:
+*>
+*> RESID = norm(B - A*X) / ( norm(A) * norm(X) * EPS ),
+*>
+*> where EPS is the machine epsilon.
+*>
+*>\endverbatim
+*
+* Arguments
+* =========
+*
+*> \param[in] UPLO
+*> \verbatim
+*> UPLO is CHARACTER*1
+*> Specifies whether the upper or lower triangular part of the
+*> Hermitian matrix A is stored:
+*> = 'U': Upper triangular
+*> = 'L': Lower triangular
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of rows and columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] NRHS
+*> \verbatim
+*> NRHS is INTEGER
+*> The number of columns of B, the matrix of right hand sides.
+*> NRHS >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is COMPLEX*16 array, dimension (LDA,N)
+*> The original Hermitian matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,N)
+*> \endverbatim
+*>
+*> \param[in] X
+*> \verbatim
+*> X is COMPLEX*16 array, dimension (LDX,NRHS)
+*> The computed solution vectors for the system of linear
+*> equations.
+*> \endverbatim
+*>
+*> \param[in] LDX
+*> \verbatim
+*> LDX is INTEGER
+*> The leading dimension of the array X. LDX >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in,out] B
+*> \verbatim
+*> B is COMPLEX*16 array, dimension (LDB,NRHS)
+*> On entry, the right hand side vectors for the system of
+*> linear equations.
+*> On exit, B is overwritten with the difference B - A*X.
+*> \endverbatim
+*>
+*> \param[in] LDB
+*> \verbatim
+*> LDB is INTEGER
+*> The leading dimension of the array B. LDB >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] RWORK
+*> \verbatim
+*> RWORK is DOUBLE PRECISION array, dimension (N)
+*> \endverbatim
+*>
+*> \param[out] RESID
+*> \verbatim
+*> RESID is DOUBLE PRECISION
+*> The maximum over the number of right hand sides of
+*> norm(B - A*X) / ( norm(A) * norm(X) * EPS ).
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup complex16_lin
+*
+* =====================================================================
SUBROUTINE ZPOT02( UPLO, N, NRHS, A, LDA, X, LDX, B, LDB, RWORK,
$ RESID )
*
* -- LAPACK test routine (version 3.1) --
-* Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-* November 2006
+* -- 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 ..
CHARACTER UPLO
@@ -15,59 +144,6 @@
COMPLEX*16 A( LDA, * ), B( LDB, * ), X( LDX, * )
* ..
*
-* Purpose
-* =======
-*
-* ZPOT02 computes the residual for the solution of a Hermitian system
-* of linear equations A*x = b:
-*
-* RESID = norm(B - A*X) / ( norm(A) * norm(X) * EPS ),
-*
-* where EPS is the machine epsilon.
-*
-* Arguments
-* =========
-*
-* UPLO (input) CHARACTER*1
-* Specifies whether the upper or lower triangular part of the
-* Hermitian matrix A is stored:
-* = 'U': Upper triangular
-* = 'L': Lower triangular
-*
-* N (input) INTEGER
-* The number of rows and columns of the matrix A. N >= 0.
-*
-* NRHS (input) INTEGER
-* The number of columns of B, the matrix of right hand sides.
-* NRHS >= 0.
-*
-* A (input) COMPLEX*16 array, dimension (LDA,N)
-* The original Hermitian matrix A.
-*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,N)
-*
-* X (input) COMPLEX*16 array, dimension (LDX,NRHS)
-* The computed solution vectors for the system of linear
-* equations.
-*
-* LDX (input) INTEGER
-* The leading dimension of the array X. LDX >= max(1,N).
-*
-* B (input/output) COMPLEX*16 array, dimension (LDB,NRHS)
-* On entry, the right hand side vectors for the system of
-* linear equations.
-* On exit, B is overwritten with the difference B - A*X.
-*
-* LDB (input) INTEGER
-* The leading dimension of the array B. LDB >= max(1,N).
-*
-* RWORK (workspace) DOUBLE PRECISION array, dimension (N)
-*
-* RESID (output) DOUBLE PRECISION
-* The maximum over the number of right hand sides of
-* norm(B - A*X) / ( norm(A) * norm(X) * EPS ).
-*
* =====================================================================
*
* .. Parameters ..