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/cgelq2.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/cgelq2.f')
-rw-r--r-- | SRC/cgelq2.f | 133 |
1 files changed, 88 insertions, 45 deletions
diff --git a/SRC/cgelq2.f b/SRC/cgelq2.f index a1b96ac8..6d6e62de 100644 --- a/SRC/cgelq2.f +++ b/SRC/cgelq2.f @@ -1,67 +1,110 @@ - SUBROUTINE CGELQ2( M, N, A, LDA, TAU, WORK, INFO ) +*> \brief \b CGELQ2 * -* -- LAPACK 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 -- +* =========== DOCUMENTATION =========== * -* .. Scalar Arguments .. - INTEGER INFO, LDA, M, N -* .. -* .. Array Arguments .. - COMPLEX A( LDA, * ), TAU( * ), WORK( * ) -* .. +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ * +* Definition +* ========== +* +* SUBROUTINE CGELQ2( M, N, A, LDA, TAU, WORK, INFO ) +* +* .. Scalar Arguments .. +* INTEGER INFO, LDA, M, N +* .. +* .. Array Arguments .. +* COMPLEX A( LDA, * ), TAU( * ), WORK( * ) +* .. +* * Purpose * ======= * -* CGELQ2 computes an LQ factorization of a complex m by n matrix A: -* A = L * Q. +*>\details \b Purpose: +*>\verbatim +*> +*> CGELQ2 computes an LQ factorization of a complex m by n matrix A: +*> A = L * Q. +*> +*>\endverbatim * * Arguments * ========= * -* M (input) INTEGER -* The number of rows of the matrix A. M >= 0. -* -* N (input) INTEGER -* The number of columns of the matrix A. N >= 0. -* -* A (input/output) COMPLEX array, dimension (LDA,N) -* On entry, the m by n matrix A. -* On exit, the elements on and below the diagonal of the array -* contain the m by min(m,n) lower trapezoidal matrix L (L is -* lower triangular if m <= n); the elements above the diagonal, -* with the array TAU, represent the unitary matrix Q as a -* product of elementary reflectors (see Further Details). +*> \param[in] M +*> \verbatim +*> M is INTEGER +*> The number of rows of the matrix A. M >= 0. +*> \endverbatim +*> +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of columns of the matrix A. N >= 0. +*> \endverbatim +*> +* +* Authors +* ======= * -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(1,M). +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* TAU (output) COMPLEX array, dimension (min(M,N)) -* The scalar factors of the elementary reflectors (see Further -* Details). +*> \date November 2011 * -* WORK (workspace) COMPLEX array, dimension (M) +*> \ingroup complexGEcomputational * -* INFO (output) INTEGER -* = 0: successful exit -* < 0: if INFO = -i, the i-th argument had an illegal value * * Further Details * =============== +*>\details \b Further \b Details +*> \verbatim +* product of elementary reflectors (see Further Details). +*> +*> LDA (input) INTEGER +*> The leading dimension of the array A. LDA >= max(1,M). +*> +*> TAU (output) COMPLEX array, dimension (min(M,N)) +*> The scalar factors of the elementary reflectors (see Further +*> Details). +*> +*> WORK (workspace) COMPLEX array, dimension (M) +*> +*> INFO (output) INTEGER +*> = 0: successful exit +*> < 0: if INFO = -i, the i-th argument had an illegal value +*> +*> +*> The matrix Q is represented as a product of elementary reflectors +*> +*> Q = H(k)**H . . . H(2)**H H(1)**H, where k = min(m,n). +*> +*> Each H(i) has the form +*> +*> H(i) = I - tau * v * v**H +*> +*> where tau is a complex scalar, and v is a complex vector with +*> v(1:i-1) = 0 and v(i) = 1; conjg(v(i+1:n)) is stored on exit in +*> A(i,i+1:n), and tau in TAU(i). +*> +*> \endverbatim +*> +* ===================================================================== + SUBROUTINE CGELQ2( M, N, A, LDA, TAU, WORK, INFO ) * -* The matrix Q is represented as a product of elementary reflectors -* -* Q = H(k)**H . . . H(2)**H H(1)**H, where k = min(m,n). -* -* Each H(i) has the form -* -* H(i) = I - tau * v * v**H +* -- LAPACK computational 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 * -* where tau is a complex scalar, and v is a complex vector with -* v(1:i-1) = 0 and v(i) = 1; conjg(v(i+1:n)) is stored on exit in -* A(i,i+1:n), and tau in TAU(i). +* .. Scalar Arguments .. + INTEGER INFO, LDA, M, N +* .. +* .. Array Arguments .. + COMPLEX A( LDA, * ), TAU( * ), WORK( * ) +* .. * * ===================================================================== * |