summaryrefslogtreecommitdiff
path: root/SRC/sorg2r.f
diff options
context:
space:
mode:
Diffstat (limited to 'SRC/sorg2r.f')
-rw-r--r--SRC/sorg2r.f144
1 files changed, 103 insertions, 41 deletions
diff --git a/SRC/sorg2r.f b/SRC/sorg2r.f
index 4fad636a..3350f129 100644
--- a/SRC/sorg2r.f
+++ b/SRC/sorg2r.f
@@ -1,60 +1,122 @@
- SUBROUTINE SORG2R( M, N, K, A, LDA, TAU, WORK, INFO )
+*> \brief \b SORG2R
*
-* -- LAPACK 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
+* =========== DOCUMENTATION ===========
*
-* .. Scalar Arguments ..
- INTEGER INFO, K, LDA, M, N
-* ..
-* .. Array Arguments ..
- REAL A( LDA, * ), TAU( * ), WORK( * )
-* ..
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
*
+* Definition
+* ==========
+*
+* SUBROUTINE SORG2R( M, N, K, A, LDA, TAU, WORK, INFO )
+*
+* .. Scalar Arguments ..
+* INTEGER INFO, K, LDA, M, N
+* ..
+* .. Array Arguments ..
+* REAL A( LDA, * ), TAU( * ), WORK( * )
+* ..
+*
* Purpose
* =======
*
-* SORG2R generates an m by n real matrix Q with orthonormal columns,
-* which is defined as the first n columns of a product of k elementary
-* reflectors of order m
-*
-* Q = H(1) H(2) . . . H(k)
-*
-* as returned by SGEQRF.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SORG2R generates an m by n real matrix Q with orthonormal columns,
+*> which is defined as the first n columns of a product of k elementary
+*> reflectors of order m
+*>
+*> Q = H(1) H(2) . . . H(k)
+*>
+*> as returned by SGEQRF.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* M (input) INTEGER
-* The number of rows of the matrix Q. M >= 0.
-*
-* N (input) INTEGER
-* The number of columns of the matrix Q. M >= N >= 0.
+*> \param[in] M
+*> \verbatim
+*> M is INTEGER
+*> The number of rows of the matrix Q. M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of columns of the matrix Q. M >= N >= 0.
+*> \endverbatim
+*>
+*> \param[in] K
+*> \verbatim
+*> K is INTEGER
+*> The number of elementary reflectors whose product defines the
+*> matrix Q. N >= K >= 0.
+*> \endverbatim
+*>
+*> \param[in,out] A
+*> \verbatim
+*> A is REAL array, dimension (LDA,N)
+*> On entry, the i-th column must contain the vector which
+*> defines the elementary reflector H(i), for i = 1,2,...,k, as
+*> returned by SGEQRF in the first k columns of its array
+*> argument A.
+*> On exit, the m-by-n matrix Q.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
+*> The first dimension of the array A. LDA >= max(1,M).
+*> \endverbatim
+*>
+*> \param[in] TAU
+*> \verbatim
+*> TAU is REAL array, dimension (K)
+*> TAU(i) must contain the scalar factor of the elementary
+*> reflector H(i), as returned by SGEQRF.
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*> WORK is REAL array, dimension (N)
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
+*> = 0: successful exit
+*> < 0: if INFO = -i, the i-th argument has an illegal value
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* K (input) INTEGER
-* The number of elementary reflectors whose product defines the
-* matrix Q. N >= K >= 0.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* A (input/output) REAL array, dimension (LDA,N)
-* On entry, the i-th column must contain the vector which
-* defines the elementary reflector H(i), for i = 1,2,...,k, as
-* returned by SGEQRF in the first k columns of its array
-* argument A.
-* On exit, the m-by-n matrix Q.
+*> \date November 2011
*
-* LDA (input) INTEGER
-* The first dimension of the array A. LDA >= max(1,M).
+*> \ingroup realOTHERcomputational
*
-* TAU (input) REAL array, dimension (K)
-* TAU(i) must contain the scalar factor of the elementary
-* reflector H(i), as returned by SGEQRF.
+* =====================================================================
+ SUBROUTINE SORG2R( M, N, K, A, LDA, TAU, WORK, INFO )
*
-* WORK (workspace) REAL array, dimension (N)
+* -- LAPACK computational 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
*
-* INFO (output) INTEGER
-* = 0: successful exit
-* < 0: if INFO = -i, the i-th argument has an illegal value
+* .. Scalar Arguments ..
+ INTEGER INFO, K, LDA, M, N
+* ..
+* .. Array Arguments ..
+ REAL A( LDA, * ), TAU( * ), WORK( * )
+* ..
*
* =====================================================================
*