summaryrefslogtreecommitdiff
path: root/SRC/dlat2s.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/dlat2s.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/dlat2s.f')
-rw-r--r--SRC/dlat2s.f149
1 files changed, 105 insertions, 44 deletions
diff --git a/SRC/dlat2s.f b/SRC/dlat2s.f
index b48e2128..d18308ef 100644
--- a/SRC/dlat2s.f
+++ b/SRC/dlat2s.f
@@ -1,60 +1,121 @@
- SUBROUTINE DLAT2S( UPLO, N, A, LDA, SA, LDSA, INFO )
-*
-* -- LAPACK PROTOTYPE auxiliary routine (version 3.3.1) --
-* -- LAPACK is a software package provided by Univ. of Tennessee, --
-* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-* -- April 2011 --
-*
-* .. Scalar Arguments ..
- CHARACTER UPLO
- INTEGER INFO, LDA, LDSA, N
-* ..
-* .. Array Arguments ..
- REAL SA( LDSA, * )
- DOUBLE PRECISION A( LDA, * )
-* ..
-*
+*> \brief \b DLAT2S
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE DLAT2S( UPLO, N, A, LDA, SA, LDSA, INFO )
+*
+* .. Scalar Arguments ..
+* CHARACTER UPLO
+* INTEGER INFO, LDA, LDSA, N
+* ..
+* .. Array Arguments ..
+* REAL SA( LDSA, * )
+* DOUBLE PRECISION A( LDA, * )
+* ..
+*
* Purpose
* =======
*
-* DLAT2S converts a DOUBLE PRECISION triangular matrix, SA, to a SINGLE
-* PRECISION triangular matrix, A.
-*
-* RMAX is the overflow for the SINGLE PRECISION arithmetic
-* DLAS2S checks that all the entries of A are between -RMAX and
-* RMAX. If not the convertion is aborted and a flag is raised.
-*
-* This is an auxiliary routine so there is no argument checking.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DLAT2S converts a DOUBLE PRECISION triangular matrix, SA, to a SINGLE
+*> PRECISION triangular matrix, A.
+*>
+*> RMAX is the overflow for the SINGLE PRECISION arithmetic
+*> DLAS2S checks that all the entries of A are between -RMAX and
+*> RMAX. If not the convertion is aborted and a flag is raised.
+*>
+*> This is an auxiliary routine so there is no argument checking.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* UPLO (input) CHARACTER*1
-* = 'U': A is upper triangular;
-* = 'L': A is lower triangular.
+*> \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 number of rows and columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*> A is DOUBLE PRECISION array, dimension (LDA,N)
+*> On entry, the N-by-N triangular coefficient matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The leading dimension of the array A. LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] SA
+*> \verbatim
+*> SA is REAL array, dimension (LDSA,N)
+*> Only the UPLO part of SA is referenced. On exit, if INFO=0,
+*> the N-by-N coefficient matrix SA; if INFO>0, the content of
+*> the UPLO part of SA is unspecified.
+*> \endverbatim
+*>
+*> \param[in] LDSA
+*> \verbatim
+*> LDSA is INTEGER
+*> The leading dimension of the array SA. LDSA >= max(1,M).
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
+*> = 0: successful exit.
+*> = 1: an entry of the matrix A is greater than the SINGLE
+*> PRECISION overflow threshold, in this case, the content
+*> of the UPLO part of SA in exit is unspecified.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* N (input) INTEGER
-* The number of rows and columns of the matrix A. N >= 0.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* A (input) DOUBLE PRECISION array, dimension (LDA,N)
-* On entry, the N-by-N triangular coefficient matrix A.
+*> \date November 2011
*
-* LDA (input) INTEGER
-* The leading dimension of the array A. LDA >= max(1,N).
+*> \ingroup doubleOTHERauxiliary
*
-* SA (output) REAL array, dimension (LDSA,N)
-* Only the UPLO part of SA is referenced. On exit, if INFO=0,
-* the N-by-N coefficient matrix SA; if INFO>0, the content of
-* the UPLO part of SA is unspecified.
+* =====================================================================
+ SUBROUTINE DLAT2S( UPLO, N, A, LDA, SA, LDSA, INFO )
*
-* LDSA (input) INTEGER
-* The leading dimension of the array SA. LDSA >= max(1,M).
+* -- LAPACK auxiliary routine (version 3.3.1) --
+* -- LAPACK is a software package provided by Univ. of Tennessee, --
+* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+* November 2011
*
-* INFO (output) INTEGER
-* = 0: successful exit.
-* = 1: an entry of the matrix A is greater than the SINGLE
-* PRECISION overflow threshold, in this case, the content
-* of the UPLO part of SA in exit is unspecified.
+* .. Scalar Arguments ..
+ CHARACTER UPLO
+ INTEGER INFO, LDA, LDSA, N
+* ..
+* .. Array Arguments ..
+ REAL SA( LDSA, * )
+ DOUBLE PRECISION A( LDA, * )
+* ..
*
* =====================================================================
*