Skip to content

Commit 230243e

Browse files
xGGRCS: documentation improvements
* fix typos * remove spurious direction value for an internal variable * fix formatting of internal variables section
1 parent 1526cb4 commit 230243e

File tree

4 files changed

+7
-19
lines changed

4 files changed

+7
-19
lines changed

SRC/cggqrcs.f

+2-5
Original file line numberDiff line numberDiff line change
@@ -292,15 +292,12 @@
292292
*> \par Internal Parameters:
293293
* =========================
294294
*>
295-
*> \param[out] W
296295
*> \verbatim
297-
*> W is REAL
296+
*> W REAL
298297
*> W is a radix power chosen such that the Frobenius norm of A
299298
*> and W*B are with SQRT(RADIX) and 1/SQRT(RADIX) of each
300299
*> other.
301-
*> \endverbatim
302300
*>
303-
*> \verbatim
304301
*> TOL REAL
305302
*> Let G = (A**H,B**H)**H. TOL is the threshold to determine
306303
*> the effective rank of G. Generally, it is set to
@@ -328,7 +325,7 @@
328325
*> \par Further Details:
329326
* =====================
330327
*>
331-
*> CGGQRCS should be significantly faster than DGGSVD3 for large
328+
*> CGGQRCS should be significantly faster than CGGSVD3 for large
332329
*> matrices because the matrices A and B are reduced to a pair of
333330
*> well-conditioned bidiagonal matrices instead of pairs of upper
334331
*> triangular matrices. On the downside, CGGQRCS requires a much larger

SRC/dggqrcs.f

+1-4
Original file line numberDiff line numberDiff line change
@@ -275,15 +275,12 @@
275275
*> \par Internal Parameters:
276276
* =========================
277277
*>
278-
*> \param[out] W
279278
*> \verbatim
280-
*> W is DOUBLE PRECISION
279+
*> W DOUBLE PRECISION
281280
*> W is a radix power chosen such that the Frobenius norm of A
282281
*> and W*B are with SQRT(RADIX) and 1/SQRT(RADIX) of each
283282
*> other.
284-
*> \endverbatim
285283
*>
286-
*> \verbatim
287284
*> TOL DOUBLE PRECISION
288285
*> Let G = (A**T,B**T)**T. TOL is the threshold to determine
289286
*> the effective rank of G. Generally, it is set to

SRC/sggqrcs.f

+2-5
Original file line numberDiff line numberDiff line change
@@ -275,15 +275,12 @@
275275
*> \par Internal Parameters:
276276
* =========================
277277
*>
278-
*> \param[out] W
279278
*> \verbatim
280-
*> W is REAL
279+
*> W REAL
281280
*> W is a radix power chosen such that the Frobenius norm of A
282281
*> and W*B are with SQRT(RADIX) and 1/SQRT(RADIX) of each
283282
*> other.
284-
*> \endverbatim
285283
*>
286-
*> \verbatim
287284
*> TOL REAL
288285
*> Let G = (A**T,B**T)**T. TOL is the threshold to determine
289286
*> the effective rank of G. Generally, it is set to
@@ -311,7 +308,7 @@
311308
*> \par Further Details:
312309
* =====================
313310
*>
314-
*> SGGQRCS should be significantly faster than DGGSVD3 for large
311+
*> SGGQRCS should be significantly faster than SGGSVD3 for large
315312
*> matrices because the matrices A and B are reduced to a pair of
316313
*> well-conditioned bidiagonal matrices instead of pairs of upper
317314
*> triangular matrices. On the downside, SGGQRCS requires a much larger

SRC/zggqrcs.f

+2-5
Original file line numberDiff line numberDiff line change
@@ -292,15 +292,12 @@
292292
*> \par Internal Parameters:
293293
* =========================
294294
*>
295-
*> \param[out] W
296295
*> \verbatim
297-
*> W is DOUBLE PRECISION
296+
*> W DOUBLE PRECISION
298297
*> W is a radix power chosen such that the Frobenius norm of A
299298
*> and W*B are with SQRT(RADIX) and 1/SQRT(RADIX) of each
300299
*> other.
301-
*> \endverbatim
302300
*>
303-
*> \verbatim
304301
*> TOL DOUBLE PRECISION
305302
*> Let G = (A**H,B**H)**H. TOL is the threshold to determine
306303
*> the effective rank of G. Generally, it is set to
@@ -328,7 +325,7 @@
328325
*> \par Further Details:
329326
* =====================
330327
*>
331-
*> ZGGQRCS should be significantly faster than DGGSVD3 for large
328+
*> ZGGQRCS should be significantly faster than ZGGSVD3 for large
332329
*> matrices because the matrices A and B are reduced to a pair of
333330
*> well-conditioned bidiagonal matrices instead of pairs of upper
334331
*> triangular matrices. On the downside, ZGGQRCS requires a much larger

0 commit comments

Comments
 (0)