summaryrefslogtreecommitdiff
path: root/SRC/strttp.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/strttp.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/strttp.f')
-rw-r--r--SRC/strttp.f142
1 files changed, 98 insertions, 44 deletions
diff --git a/SRC/strttp.f b/SRC/strttp.f
index e0e8ac11..be63cf75 100644
--- a/SRC/strttp.f
+++ b/SRC/strttp.f
@@ -1,12 +1,105 @@
- SUBROUTINE STRTTP( UPLO, N, A, LDA, AP, INFO )
+*> \brief \b STRTTP
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE STRTTP( UPLO, N, A, LDA, AP, INFO )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER INFO, N, LDA
+* ..
+* .. Array Arguments ..
+* REAL A( LDA, * ), AP( * )
+* ..
+*
+* Purpose
+* =======
+*
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> STRTTP copies a triangular matrix A from full format (TR) to standard
+*> packed format (TP).
+*>
+*>\endverbatim
+*
+* Arguments
+* =========
+*
+*> \param[in] UPLO
+*> \verbatim
+*> UPLO is CHARACTER*1
+*> = 'U': A is upper triangular.
+*> = 'L': A is lower triangular.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The order of the matrices AP and A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is REAL array, dimension (LDA,N)
+*> On exit, the triangular matrix A. If UPLO = 'U', the leading
+*> N-by-N upper triangular part of A contains the upper
+*> triangular part of the matrix A, and the strictly lower
+*> triangular part of A is not referenced. If UPLO = 'L', the
+*> leading N-by-N lower triangular part of A contains the lower
+*> triangular part of the matrix A, and the strictly upper
+*> triangular part of A is not referenced.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] AP
+*> \verbatim
+*> AP is REAL array, dimension (N*(N+1)/2
+*> On exit, the upper or lower triangular matrix A, packed
+*> columnwise in a linear array. The j-th column of A is stored
+*> in the array AP as follows:
+*> if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j;
+*> if UPLO = 'L', AP(i + (j-1)*(2n-j)/2) = A(i,j) for j<=i<=n.
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
+*> = 0: successful exit
+*> < 0: if INFO = -i, the i-th argument had an illegal value
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
*
-* -- LAPACK routine (version 3.3.0) --
-* -- Contributed by Fred Gustavson of the IBM Watson Research Center --
-* -- and Julien Langou of the Univ. of Colorado Denver --
-* November 2010
+*> \ingroup realOTHERcomputational
*
+* =====================================================================
+ SUBROUTINE STRTTP( UPLO, N, A, LDA, AP, INFO )
+*
+* -- LAPACK computational routine (version 3.3.0) --
* -- 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
@@ -16,45 +109,6 @@
REAL A( LDA, * ), AP( * )
* ..
*
-* Purpose
-* =======
-*
-* STRTTP copies a triangular matrix A from full format (TR) to standard
-* packed format (TP).
-*
-* Arguments
-* =========
-*
-* UPLO (input) CHARACTER*1
-* = 'U': A is upper triangular.
-* = 'L': A is lower triangular.
-*
-* N (input) INTEGER
-* The order of the matrices AP and A. N >= 0.
-*
-* A (input) REAL array, dimension (LDA,N)
-* On exit, the triangular matrix A. If UPLO = 'U', the leading
-* N-by-N upper triangular part of A contains the upper
-* triangular part of the matrix A, and the strictly lower
-* triangular part of A is not referenced. If UPLO = 'L', the
-* leading N-by-N lower triangular part of A contains the lower
-* triangular part of the matrix A, and the strictly upper
-* triangular part of A is not referenced.
-*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,N).
-*
-* AP (output) REAL array, dimension (N*(N+1)/2
-* On exit, the upper or lower triangular matrix A, packed
-* columnwise in a linear array. The j-th column of A is stored
-* in the array AP as follows:
-* if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j;
-* if UPLO = 'L', AP(i + (j-1)*(2n-j)/2) = A(i,j) for j<=i<=n.
-*
-* INFO (output) INTEGER
-* = 0: successful exit
-* < 0: if INFO = -i, the i-th argument had an illegal value
-*
* =====================================================================
*
* .. Parameters ..