diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/zlartv.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/zlartv.f')
-rw-r--r-- | SRC/zlartv.f | 137 |
1 files changed, 100 insertions, 37 deletions
diff --git a/SRC/zlartv.f b/SRC/zlartv.f index 114a577d..883ebf40 100644 --- a/SRC/zlartv.f +++ b/SRC/zlartv.f @@ -1,53 +1,116 @@ - SUBROUTINE ZLARTV( N, X, INCX, Y, INCY, C, S, INCC ) -* -* -- 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 INCC, INCX, INCY, N -* .. -* .. Array Arguments .. - DOUBLE PRECISION C( * ) - COMPLEX*16 S( * ), X( * ), Y( * ) -* .. -* +*> \brief \b ZLARTV +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE ZLARTV( N, X, INCX, Y, INCY, C, S, INCC ) +* +* .. Scalar Arguments .. +* INTEGER INCC, INCX, INCY, N +* .. +* .. Array Arguments .. +* DOUBLE PRECISION C( * ) +* COMPLEX*16 S( * ), X( * ), Y( * ) +* .. +* * Purpose * ======= * -* ZLARTV applies a vector of complex plane rotations with real cosines -* to elements of the complex vectors x and y. For i = 1,2,...,n -* -* ( x(i) ) := ( c(i) s(i) ) ( x(i) ) -* ( y(i) ) ( -conjg(s(i)) c(i) ) ( y(i) ) +*>\details \b Purpose: +*>\verbatim +*> +*> ZLARTV applies a vector of complex plane rotations with real cosines +*> to elements of the complex vectors x and y. For i = 1,2,...,n +*> +*> ( x(i) ) := ( c(i) s(i) ) ( x(i) ) +*> ( y(i) ) ( -conjg(s(i)) c(i) ) ( y(i) ) +*> +*>\endverbatim * * Arguments * ========= * -* N (input) INTEGER -* The number of plane rotations to be applied. -* -* X (input/output) COMPLEX*16 array, dimension (1+(N-1)*INCX) -* The vector x. +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of plane rotations to be applied. +*> \endverbatim +*> +*> \param[in,out] X +*> \verbatim +*> X is COMPLEX*16 array, dimension (1+(N-1)*INCX) +*> The vector x. +*> \endverbatim +*> +*> \param[in] INCX +*> \verbatim +*> INCX is INTEGER +*> The increment between elements of X. INCX > 0. +*> \endverbatim +*> +*> \param[in,out] Y +*> \verbatim +*> Y is COMPLEX*16 array, dimension (1+(N-1)*INCY) +*> The vector y. +*> \endverbatim +*> +*> \param[in] INCY +*> \verbatim +*> INCY is INTEGER +*> The increment between elements of Y. INCY > 0. +*> \endverbatim +*> +*> \param[in] C +*> \verbatim +*> C is DOUBLE PRECISION array, dimension (1+(N-1)*INCC) +*> The cosines of the plane rotations. +*> \endverbatim +*> +*> \param[in] S +*> \verbatim +*> S is COMPLEX*16 array, dimension (1+(N-1)*INCC) +*> The sines of the plane rotations. +*> \endverbatim +*> +*> \param[in] INCC +*> \verbatim +*> INCC is INTEGER +*> The increment between elements of C and S. INCC > 0. +*> \endverbatim +*> +* +* Authors +* ======= * -* INCX (input) INTEGER -* The increment between elements of X. INCX > 0. +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* Y (input/output) COMPLEX*16 array, dimension (1+(N-1)*INCY) -* The vector y. +*> \date November 2011 * -* INCY (input) INTEGER -* The increment between elements of Y. INCY > 0. +*> \ingroup complex16OTHERauxiliary * -* C (input) DOUBLE PRECISION array, dimension (1+(N-1)*INCC) -* The cosines of the plane rotations. +* ===================================================================== + SUBROUTINE ZLARTV( N, X, INCX, Y, INCY, C, S, INCC ) * -* S (input) COMPLEX*16 array, dimension (1+(N-1)*INCC) -* The sines of the plane rotations. +* -- 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 * -* INCC (input) INTEGER -* The increment between elements of C and S. INCC > 0. +* .. Scalar Arguments .. + INTEGER INCC, INCX, INCY, N +* .. +* .. Array Arguments .. + DOUBLE PRECISION C( * ) + COMPLEX*16 S( * ), X( * ), Y( * ) +* .. * * ===================================================================== * |