summaryrefslogtreecommitdiff
path: root/SRC/clacpy.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/clacpy.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/clacpy.f')
-rw-r--r--SRC/clacpy.f132
1 files changed, 96 insertions, 36 deletions
diff --git a/SRC/clacpy.f b/SRC/clacpy.f
index 0155a620..e07d664f 100644
--- a/SRC/clacpy.f
+++ b/SRC/clacpy.f
@@ -1,52 +1,112 @@
- SUBROUTINE CLACPY( UPLO, M, N, A, LDA, B, LDB )
-*
-* -- 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
-*
-* .. Scalar Arguments ..
- CHARACTER UPLO
- INTEGER LDA, LDB, M, N
-* ..
-* .. Array Arguments ..
- COMPLEX A( LDA, * ), B( LDB, * )
-* ..
-*
+*> \brief \b CLACPY
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE CLACPY( UPLO, M, N, A, LDA, B, LDB )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER LDA, LDB, M, N
+* ..
+* .. Array Arguments ..
+* COMPLEX A( LDA, * ), B( LDB, * )
+* ..
+*
* Purpose
* =======
*
-* CLACPY copies all or part of a two-dimensional matrix A to another
-* matrix B.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLACPY copies all or part of a two-dimensional matrix A to another
+*> matrix B.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* UPLO (input) CHARACTER*1
-* Specifies the part of the matrix A to be copied to B.
-* = 'U': Upper triangular part
-* = 'L': Lower triangular part
-* Otherwise: All of the matrix A
+*> \param[in] UPLO
+*> \verbatim
+*> UPLO is CHARACTER*1
+*> Specifies the part of the matrix A to be copied to B.
+*> = 'U': Upper triangular part
+*> = 'L': Lower triangular part
+*> Otherwise: All of the matrix A
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*> M is INTEGER
+*> The number of rows of the matrix A. M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is COMPLEX array, dimension (LDA,N)
+*> The m by n matrix A. If UPLO = 'U', only the upper trapezium
+*> is accessed; if UPLO = 'L', only the lower trapezium is
+*> accessed.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,M).
+*> \endverbatim
+*>
+*> \param[out] B
+*> \verbatim
+*> B is COMPLEX array, dimension (LDB,N)
+*> On exit, B = A in the locations specified by UPLO.
+*> \endverbatim
+*>
+*> \param[in] LDB
+*> \verbatim
+*> LDB is INTEGER
+*> The leading dimension of the array B. LDB >= max(1,M).
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* M (input) INTEGER
-* The number of rows of the matrix A. M >= 0.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* N (input) INTEGER
-* The number of columns of the matrix A. N >= 0.
+*> \date November 2011
*
-* A (input) COMPLEX array, dimension (LDA,N)
-* The m by n matrix A. If UPLO = 'U', only the upper trapezium
-* is accessed; if UPLO = 'L', only the lower trapezium is
-* accessed.
+*> \ingroup complexOTHERauxiliary
*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,M).
+* =====================================================================
+ SUBROUTINE CLACPY( UPLO, M, N, A, LDA, B, LDB )
*
-* B (output) COMPLEX array, dimension (LDB,N)
-* On exit, B = A in the locations specified by UPLO.
+* -- 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 2011
*
-* LDB (input) INTEGER
-* The leading dimension of the array B. LDB >= max(1,M).
+* .. Scalar Arguments ..
+ CHARACTER UPLO
+ INTEGER LDA, LDB, M, N
+* ..
+* .. Array Arguments ..
+ COMPLEX A( LDA, * ), B( LDB, * )
+* ..
*
* =====================================================================
*