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/zlaqr1.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/zlaqr1.f')
-rw-r--r-- | SRC/zlaqr1.f | 136 |
1 files changed, 98 insertions, 38 deletions
diff --git a/SRC/zlaqr1.f b/SRC/zlaqr1.f index a12c3d82..863f7645 100644 --- a/SRC/zlaqr1.f +++ b/SRC/zlaqr1.f @@ -1,56 +1,116 @@ - SUBROUTINE ZLAQR1( N, H, LDH, S1, S2, V ) -* -* -- LAPACK auxiliary routine (version 3.2) -- -* Univ. of Tennessee, Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd.. -* November 2006 -* -* .. Scalar Arguments .. - COMPLEX*16 S1, S2 - INTEGER LDH, N -* .. -* .. Array Arguments .. - COMPLEX*16 H( LDH, * ), V( * ) -* .. -* +*> \brief \b ZLAQR1 +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE ZLAQR1( N, H, LDH, S1, S2, V ) +* +* .. Scalar Arguments .. +* COMPLEX*16 S1, S2 +* INTEGER LDH, N +* .. +* .. Array Arguments .. +* COMPLEX*16 H( LDH, * ), V( * ) +* .. +* * Purpose * ======= * -* Given a 2-by-2 or 3-by-3 matrix H, ZLAQR1 sets v to a -* scalar multiple of the first column of the product -* -* (*) K = (H - s1*I)*(H - s2*I) -* -* scaling to avoid overflows and most underflows. -* -* This is useful for starting double implicit shift bulges -* in the QR algorithm. +*>\details \b Purpose: +*>\verbatim +*> +*> Given a 2-by-2 or 3-by-3 matrix H, ZLAQR1 sets v to a +*> scalar multiple of the first column of the product +*> +*> (*) K = (H - s1*I)*(H - s2*I) +*> +*> scaling to avoid overflows and most underflows. +*> +*> This is useful for starting double implicit shift bulges +*> in the QR algorithm. +*> +*>\endverbatim * * Arguments * ========= * -* N (input) integer -* Order of the matrix H. N must be either 2 or 3. +*> \param[in] N +*> \verbatim +*> N is integer +*> Order of the matrix H. N must be either 2 or 3. +*> \endverbatim +*> +*> \param[in] H +*> \verbatim +*> H is COMPLEX*16 array of dimension (LDH,N) +*> The 2-by-2 or 3-by-3 matrix H in (*). +*> \endverbatim +*> +*> \param[in] LDH +*> \verbatim +*> LDH is integer +*> The leading dimension of H as declared in +*> the calling procedure. LDH.GE.N +*> \endverbatim +*> +*> \param[in] S1 +*> \verbatim +*> S1 is COMPLEX*16 +*> S2 S1 and S2 are the shifts defining K in (*) above. +*> \endverbatim +*> +*> \param[out] V +*> \verbatim +*> V is COMPLEX*16 array of dimension N +*> A scalar multiple of the first column of the +*> matrix K in (*). +*> \endverbatim +*> +* +* Authors +* ======= * -* H (input) COMPLEX*16 array of dimension (LDH,N) -* The 2-by-2 or 3-by-3 matrix H in (*). +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* LDH (input) integer -* The leading dimension of H as declared in -* the calling procedure. LDH.GE.N +*> \date November 2011 * -* S1 (input) COMPLEX*16 -* S2 S1 and S2 are the shifts defining K in (*) above. +*> \ingroup complex16OTHERauxiliary * -* V (output) COMPLEX*16 array of dimension N -* A scalar multiple of the first column of the -* matrix K in (*). * * Further Details * =============== +*>\details \b Further \b Details +*> \verbatim +*> +*> Based on contributions by +*> Karen Braman and Ralph Byers, Department of Mathematics, +*> University of Kansas, USA +*> +*> \endverbatim +*> +* ===================================================================== + SUBROUTINE ZLAQR1( N, H, LDH, S1, S2, V ) * -* Based on contributions by -* Karen Braman and Ralph Byers, Department of Mathematics, -* University of Kansas, USA +* -- 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 +* +* .. Scalar Arguments .. + COMPLEX*16 S1, S2 + INTEGER LDH, N +* .. +* .. Array Arguments .. + COMPLEX*16 H( LDH, * ), V( * ) +* .. * * ================================================================ * |