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/sgerqf.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/sgerqf.f')
-rw-r--r-- | SRC/sgerqf.f | 158 |
1 files changed, 99 insertions, 59 deletions
diff --git a/SRC/sgerqf.f b/SRC/sgerqf.f index 875c557f..c1216828 100644 --- a/SRC/sgerqf.f +++ b/SRC/sgerqf.f @@ -1,81 +1,121 @@ - SUBROUTINE SGERQF( M, N, A, LDA, TAU, WORK, LWORK, INFO ) +*> \brief \b SGERQF * -* -- 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, LWORK, M, N -* .. -* .. Array Arguments .. - REAL A( LDA, * ), TAU( * ), WORK( * ) -* .. +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ * +* Definition +* ========== +* +* SUBROUTINE SGERQF( M, N, A, LDA, TAU, WORK, LWORK, INFO ) +* +* .. Scalar Arguments .. +* INTEGER INFO, LDA, LWORK, M, N +* .. +* .. Array Arguments .. +* REAL A( LDA, * ), TAU( * ), WORK( * ) +* .. +* * Purpose * ======= * -* SGERQF computes an RQ factorization of a real M-by-N matrix A: -* A = R * Q. +*>\details \b Purpose: +*>\verbatim +*> +*> SGERQF computes an RQ factorization of a real M-by-N matrix A: +*> A = R * 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) REAL array, dimension (LDA,N) -* On entry, the M-by-N matrix A. -* On exit, -* if m <= n, the upper triangle of the subarray -* A(1:m,n-m+1:n) contains the M-by-M upper triangular matrix R; -* if m >= n, the elements on and above the (m-n)-th subdiagonal -* contain the M-by-N upper trapezoidal matrix R; -* the remaining elements, with the array TAU, represent the -* orthogonal matrix Q as a product of min(m,n) elementary -* reflectors (see Further Details). -* -* LDA (input) INTEGER -* The leading dimension of the array A. LDA >= max(1,M). -* -* TAU (output) REAL array, dimension (min(M,N)) -* The scalar factors of the 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 +* ======= * -* WORK (workspace/output) REAL array, dimension (MAX(1,LWORK)) -* On exit, if INFO = 0, WORK(1) returns the optimal LWORK. +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* LWORK (input) INTEGER -* The dimension of the array WORK. LWORK >= max(1,M). -* For optimum performance LWORK >= M*NB, where NB is -* the optimal blocksize. +*> \date November 2011 * -* If LWORK = -1, then a workspace query is assumed; the routine -* only calculates the optimal size of the WORK array, returns -* this value as the first entry of the WORK array, and no error -* message related to LWORK is issued by XERBLA. +*> \ingroup realGEcomputational * -* 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 +* reflectors (see Further Details). +*> +*> LDA (input) INTEGER +*> The leading dimension of the array A. LDA >= max(1,M). +*> +*> TAU (output) REAL array, dimension (min(M,N)) +*> The scalar factors of the elementary reflectors (see Further +*> Details). +*> +*> WORK (workspace/output) REAL array, dimension (MAX(1,LWORK)) +*> On exit, if INFO = 0, WORK(1) returns the optimal LWORK. +*> +*> LWORK (input) INTEGER +*> The dimension of the array WORK. LWORK >= max(1,M). +*> For optimum performance LWORK >= M*NB, where NB is +*> the optimal blocksize. +*> +*> If LWORK = -1, then a workspace query is assumed; the routine +*> only calculates the optimal size of the WORK array, returns +*> this value as the first entry of the WORK array, and no error +*> message related to LWORK is issued by XERBLA. +*> +*> 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(1) H(2) . . . H(k), where k = min(m,n). +*> +*> Each H(i) has the form +*> +*> H(i) = I - tau * v * v**T +*> +*> where tau is a real scalar, and v is a real vector with +*> v(n-k+i+1:n) = 0 and v(n-k+i) = 1; v(1:n-k+i-1) is stored on exit in +*> A(m-k+i,1:n-k+i-1), and tau in TAU(i). +*> +*> \endverbatim +*> +* ===================================================================== + SUBROUTINE SGERQF( M, N, A, LDA, TAU, WORK, LWORK, INFO ) * -* The matrix Q is represented as a product of elementary reflectors -* -* Q = H(1) H(2) . . . H(k), where k = min(m,n). -* -* Each H(i) has the form -* -* H(i) = I - tau * v * v**T +* -- 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 real scalar, and v is a real vector with -* v(n-k+i+1:n) = 0 and v(n-k+i) = 1; v(1:n-k+i-1) is stored on exit in -* A(m-k+i,1:n-k+i-1), and tau in TAU(i). +* .. Scalar Arguments .. + INTEGER INFO, LDA, LWORK, M, N +* .. +* .. Array Arguments .. + REAL A( LDA, * ), TAU( * ), WORK( * ) +* .. * * ===================================================================== * |