Merge pull request #1156 from TiborGY/fix_gelqt_docs

Fix errors in the documentation of ?gelqt

Author: langou

SRC/cgelqt.f

@@ -40,7 +40,7 @@
 *> \param[in] MB
 *> \verbatim
 *>          MB is INTEGER
-*>          The block size to be used in the blocked QR.  MIN(M,N) >= MB >= 1.
+*>          The block size to be used in the blocked LQ.  MIN(M,N) >= MB >= 1.
 *> \endverbatim
 *>
 *> \param[in,out] A
@@ -75,7 +75,10 @@
 *>
 *> \param[out] WORK
 *> \verbatim
-*>          WORK is COMPLEX array, dimension (MB*N)
+*>          WORK is COMPLEX array, dimension (MB*M).
+*>          Note: A smaller workspace of MB*(M-MB) may also be sufficient, but
+*>          that is yet to be proven. MB*M is a conservative estimate and the
+*>          recommended value to use.
 *> \endverbatim
 *>
 *> \param[out] INFO
@@ -101,7 +104,7 @@
 *> \verbatim
 *>
 *>  The matrix V stores the elementary reflectors H(i) in the i-th row
-*>  above the diagonal. For example, if M=5 and N=3, the matrix V is
+*>  above the diagonal. For example, if M=3 and N=5, the matrix V is
 *>
 *>               V = (  1  v1 v1 v1 v1 )
 *>                   (     1  v2 v2 v2 )

SRC/dgelqt.f

@@ -53,7 +53,7 @@
 *> \param[in] MB
 *> \verbatim
 *>          MB is INTEGER
-*>          The block size to be used in the blocked QR.  MIN(M,N) >= MB >= 1.
+*>          The block size to be used in the blocked LQ.  MIN(M,N) >= MB >= 1.
 *> \endverbatim
 *>
 *> \param[in,out] A
@@ -88,7 +88,10 @@
 *>
 *> \param[out] WORK
 *> \verbatim
-*>          WORK is DOUBLE PRECISION array, dimension (MB*N)
+*>          WORK is DOUBLE PRECISION array, dimension (MB*M).
+*>          Note: A smaller workspace of MB*(M-MB) may also be sufficient, but
+*>          that is yet to be proven. MB*M is a conservative estimate and the
+*>          recommended value to use.
 *> \endverbatim
 *>
 *> \param[out] INFO
@@ -114,7 +117,7 @@
 *> \verbatim
 *>
 *>  The matrix V stores the elementary reflectors H(i) in the i-th row
-*>  above the diagonal. For example, if M=5 and N=3, the matrix V is
+*>  above the diagonal. For example, if M=3 and N=5, the matrix V is
 *>
 *>               V = (  1  v1 v1 v1 v1 )
 *>                   (     1  v2 v2 v2 )

SRC/sgelqt.f

@@ -40,7 +40,7 @@
 *> \param[in] MB
 *> \verbatim
 *>          MB is INTEGER
-*>          The block size to be used in the blocked QR.  MIN(M,N) >= MB >= 1.
+*>          The block size to be used in the blocked LQ.  MIN(M,N) >= MB >= 1.
 *> \endverbatim
 *>
 *> \param[in,out] A
@@ -75,7 +75,10 @@
 *>
 *> \param[out] WORK
 *> \verbatim
-*>          WORK is REAL array, dimension (MB*N)
+*>          WORK is REAL array, dimension (MB*M).
+*>          Note: A smaller workspace of MB*(M-MB) may also be sufficient, but
+*>          that is yet to be proven. MB*M is a conservative estimate and the
+*>          recommended value to use.
 *> \endverbatim
 *>
 *> \param[out] INFO
@@ -101,7 +104,7 @@
 *> \verbatim
 *>
 *>  The matrix V stores the elementary reflectors H(i) in the i-th row
-*>  above the diagonal. For example, if M=5 and N=3, the matrix V is
+*>  above the diagonal. For example, if M=3 and N=5, the matrix V is
 *>
 *>               V = (  1  v1 v1 v1 v1 )
 *>                   (     1  v2 v2 v2 )

SRC/zgelqt.f

@@ -53,7 +53,7 @@
 *> \param[in] MB
 *> \verbatim
 *>          MB is INTEGER
-*>          The block size to be used in the blocked QR.  MIN(M,N) >= MB >= 1.
+*>          The block size to be used in the blocked LQ.  MIN(M,N) >= MB >= 1.
 *> \endverbatim
 *>
 *> \param[in,out] A
@@ -88,7 +88,10 @@
 *>
 *> \param[out] WORK
 *> \verbatim
-*>          WORK is COMPLEX*16 array, dimension (MB*N)
+*>          WORK is COMPLEX*16 array, dimension (MB*M).
+*>          Note: A smaller workspace of MB*(M-MB) may also be sufficient, but
+*>          that is yet to be proven. MB*M is a conservative estimate and the
+*>          recommended value to use.
 *> \endverbatim
 *>
 *> \param[out] INFO
@@ -114,7 +117,7 @@
 *> \verbatim
 *>
 *>  The matrix V stores the elementary reflectors H(i) in the i-th row
-*>  above the diagonal. For example, if M=5 and N=3, the matrix V is
+*>  above the diagonal. For example, if M=3 and N=5, the matrix V is
 *>
 *>               V = (  1  v1 v1 v1 v1 )
 *>                   (     1  v2 v2 v2 )