summaryrefslogtreecommitdiff
path: root/SRC/dtpmqrt.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
commit0d9e213c670ab0e68f17d68251412d53250108e1 (patch)
tree2bcab1c08b84e327b9be345385e2c31e8a26905a /SRC/dtpmqrt.f
parent82901cd3e7bb75c73fc3a17fe7bf922289337f97 (diff)
downloadlapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.gz
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.bz2
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.zip
Correct Warning detected during Doxygen Generation.
Now each routine should have the correct list of arguments. This allowed to detect and fix problems in parameter description of many routines.
Diffstat (limited to 'SRC/dtpmqrt.f')
-rw-r--r--SRC/dtpmqrt.f104
1 files changed, 71 insertions, 33 deletions
diff --git a/SRC/dtpmqrt.f b/SRC/dtpmqrt.f
index ec1663de..ee109435 100644
--- a/SRC/dtpmqrt.f
+++ b/SRC/dtpmqrt.f
@@ -67,6 +67,7 @@
*> \verbatim
*> N is INTEGER
*> The number of columns of the matrix B. N >= 0.
+*> \endverbatim
*>
*> \param[in] K
*> \verbatim
@@ -74,78 +75,115 @@
*> The number of elementary reflectors whose product defines
*> the matrix Q.
*> \endverbatim
-*> \endverbatim
*>
-*
-* Authors
-* =======
-*
-*> \author Univ. of Tennessee
-*> \author Univ. of California Berkeley
-*> \author Univ. of Colorado Denver
-*> \author NAG Ltd.
-*
-*> \date November 2011
-*
-*> \ingroup doubleOTHERcomputational
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[in] L
*> \verbatim
-* K >= L >= 0. See Further Details.
+*> L is INTEGER
+*> The order of the trapezoidal part of V.
+*> K >= L >= 0. See Further Details.
+*> \endverbatim
*>
-*> NB (input) INTEGER
+*> \param[in] NB
+*> \verbatim
+*> NB is INTEGER
*> The block size used for the storage of T. K >= NB >= 1.
*> This must be the same value of NB used to generate T
*> in CTPQRT.
+*> \endverbatim
*>
-*> V (input) DOUBLE PRECISION array, dimension (LDA,K)
+*> \param[in] V
+*> \verbatim
+*> V is DOUBLE PRECISION array, dimension (LDA,K)
*> The i-th column must contain the vector which defines the
*> elementary reflector H(i), for i = 1,2,...,k, as returned by
*> CTPQRT in B. See Further Details.
+*> \endverbatim
*>
-*> LDA (input) INTEGER
-*> The leading dimension of the array A.
-*> If SIDE = 'L', LDA >= max(1,M);
-*> if SIDE = 'R', LDA >= max(1,N).
+*> \param[in] LDV
+*> \verbatim
+*> LDV is INTEGER
+*> The leading dimension of the array V.
+*> If SIDE = 'L', LDV >= max(1,M);
+*> if SIDE = 'R', LDV >= max(1,N).
+*> \endverbatim
*>
-*> T (input) DOUBLE PRECISION array, dimension (LDT,K)
+*> \param[in] T
+*> \verbatim
+*> T is DOUBLE PRECISION array, dimension (LDT,K)
*> The upper triangular factors of the block reflectors
*> as returned by CTPQRT, stored as a NB-by-K matrix.
+*> \endverbatim
*>
-*> LDT (input) INTEGER
+*> \param[in] LDT
+*> \verbatim
+*> LDT is INTEGER
*> The leading dimension of the array T. LDT >= NB.
+*> \endverbatim
*>
-*> A (input/output) DOUBLE PRECISION array, dimension
+*> \param[in,out] A
+*> \verbatim
+*> A is DOUBLE PRECISION array, dimension
*> (LDA,N) if SIDE = 'L' or
*> (LDA,K) if SIDE = 'R'
*> On entry, the K-by-N or M-by-K matrix A.
*> On exit, A is overwritten by the corresponding block of
*> Q*C or Q**T*C or C*Q or C*Q**T. See Further Details.
+*> \endverbatim
*>
-*> LDA (input) INTEGER
+*> \param[in] LDA
+*> \verbatim
+*> LDA is INTEGER
*> The leading dimension of the array A.
*> If SIDE = 'L', LDC >= max(1,K);
*> If SIDE = 'R', LDC >= max(1,M).
+*> \endverbatim
*>
-*> B (input/output) DOUBLE PRECISION array, dimension (LDB,N)
+*> \param[in,out] B
+*> \verbatim
+*> B is DOUBLE PRECISION array, dimension (LDB,N)
*> On entry, the M-by-N matrix B.
*> On exit, B is overwritten by the corresponding block of
*> Q*C or Q**T*C or C*Q or C*Q**T. See Further Details.
+*> \endverbatim
*>
-*> LDB (input) INTEGER
+*> \param[in] LDB
+*> \verbatim
+*> LDB is INTEGER
*> The leading dimension of the array B.
*> LDB >= max(1,M).
+*> \endverbatim
*>
-*> WORK (workspace/output) DOUBLE PRECISION array. The dimension of WORK is
+*> \param[out] WORK
+*> \verbatim
+*> WORK is DOUBLE PRECISION array. The dimension of WORK is
*> N*NB if SIDE = 'L', or M*NB if SIDE = 'R'.
+*> \endverbatim
*>
-*> INFO (output) INTEGER
+*> \param[out] INFO
+*> \verbatim
+*> INFO is INTEGER
*> = 0: successful exit
*> < 0: if INFO = -i, the i-th argument had an illegal value
+*> \endverbatim
*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup doubleOTHERcomputational
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The columns of the pentagonal matrix V contain the elementary reflectors
*> H(1), H(2), ..., H(K); V is composed of a rectangular block V1 and a