summaryrefslogtreecommitdiff
path: root/SRC/clacrt.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/clacrt.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/clacrt.f')
-rw-r--r--SRC/clacrt.f136
1 files changed, 98 insertions, 38 deletions
diff --git a/SRC/clacrt.f b/SRC/clacrt.f
index 213071e6..f4d9bb5f 100644
--- a/SRC/clacrt.f
+++ b/SRC/clacrt.f
@@ -1,54 +1,114 @@
- SUBROUTINE CLACRT( N, CX, INCX, CY, INCY, C, S )
-*
-* -- 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 ..
- INTEGER INCX, INCY, N
- COMPLEX C, S
-* ..
-* .. Array Arguments ..
- COMPLEX CX( * ), CY( * )
-* ..
-*
+*> \brief \b CLACRT
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE CLACRT( N, CX, INCX, CY, INCY, C, S )
+*
+* .. Scalar Arguments ..
+* INTEGER INCX, INCY, N
+* COMPLEX C, S
+* ..
+* .. Array Arguments ..
+* COMPLEX CX( * ), CY( * )
+* ..
+*
* Purpose
* =======
*
-* CLACRT performs the operation
-*
-* ( c s )( x ) ==> ( x )
-* ( -s c )( y ) ( y )
-*
-* where c and s are complex and the vectors x and y are complex.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLACRT performs the operation
+*>
+*> ( c s )( x ) ==> ( x )
+*> ( -s c )( y ) ( y )
+*>
+*> where c and s are complex and the vectors x and y are complex.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* N (input) INTEGER
-* The number of elements in the vectors CX and CY.
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of elements in the vectors CX and CY.
+*> \endverbatim
+*>
+*> \param[in,out] CX
+*> \verbatim
+*> CX is COMPLEX array, dimension (N)
+*> On input, the vector x.
+*> On output, CX is overwritten with c*x + s*y.
+*> \endverbatim
+*>
+*> \param[in] INCX
+*> \verbatim
+*> INCX is INTEGER
+*> The increment between successive values of CX. INCX <> 0.
+*> \endverbatim
+*>
+*> \param[in,out] CY
+*> \verbatim
+*> CY is COMPLEX array, dimension (N)
+*> On input, the vector y.
+*> On output, CY is overwritten with -s*x + c*y.
+*> \endverbatim
+*>
+*> \param[in] INCY
+*> \verbatim
+*> INCY is INTEGER
+*> The increment between successive values of CY. INCY <> 0.
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*> C is COMPLEX
+*> \endverbatim
+*>
+*> \param[in] S
+*> \verbatim
+*> S is COMPLEX
+*> C and S define the matrix
+*> [ C S ].
+*> [ -S C ]
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* CX (input/output) COMPLEX array, dimension (N)
-* On input, the vector x.
-* On output, CX is overwritten with c*x + s*y.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* INCX (input) INTEGER
-* The increment between successive values of CX. INCX <> 0.
+*> \date November 2011
*
-* CY (input/output) COMPLEX array, dimension (N)
-* On input, the vector y.
-* On output, CY is overwritten with -s*x + c*y.
+*> \ingroup complexOTHERauxiliary
*
-* INCY (input) INTEGER
-* The increment between successive values of CY. INCY <> 0.
+* =====================================================================
+ SUBROUTINE CLACRT( N, CX, INCX, CY, INCY, C, S )
*
-* C (input) COMPLEX
+* -- 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
*
-* S (input) COMPLEX
-* C and S define the matrix
-* [ C S ].
-* [ -S C ]
+* .. Scalar Arguments ..
+ INTEGER INCX, INCY, N
+ COMPLEX C, S
+* ..
+* .. Array Arguments ..
+ COMPLEX CX( * ), CY( * )
+* ..
*
* =====================================================================
*