Bug in documentation of BLAS1 complex dot *FIXED*

[zerothi]

The documentation for the complex dot product codes is erroneous.

I here attach a patch which fixes the ambiguity and streamlines the documentation of the complex dot routines.

[admin]

Thank you
I will review your suggestion with the BLAS authors.
This documentation comes actually from the original codes.
There is a little history in those. We always have been hesitating to change them.

[zerothi]

Ok.

It is just when you visit http://www.netlib.org/lapack/explore-ht ... tc_8f.html
or the others it is "erroneous".

Thanks for your consideration.

[Julien Langou]

A good pointer for getting the functionality of the BLAS subroutines is: http://www.netlib.org/blas/blasqr.pdf
This said, there is no reason for the header of the subroutine to be somewhat more descriptive. Good point. And that way the doxygen documentation will be better as well.
I just committed some edits to the comments based along your suggestions. Thanks! Julien.

Code: Select all

Index: cdotc.f
===================================================================
--- cdotc.f   (revision 1579)
+++ cdotc.f   (working copy)
@@ -23,8 +23,9 @@
 *>
 *> \verbatim
 *>
-*>    forms the dot product of two vectors, conjugating the first
-*>    vector.
+*> CDOTC forms the dot product of two complex vectors
+*>      CDOTC = X^H * Y
+*>
 *> \endverbatim
 *
 *  Authors:
Index: cdotu.f
===================================================================
--- cdotu.f   (revision 1579)
+++ cdotu.f   (working copy)
@@ -23,7 +23,9 @@
 *>
 *> \verbatim
 *>
-*>    CDOTU forms the dot product of two vectors.
+*> CDOTU forms the dot product of two complex vectors
+*>      CDOTU = X^T * Y
+*>
 *> \endverbatim
 *
 *  Authors:
Index: zdotc.f
===================================================================
--- zdotc.f   (revision 1579)
+++ zdotc.f   (working copy)
@@ -23,7 +23,9 @@
 *>
 *> \verbatim
 *>
-*> ZDOTC forms the dot product of a vector.
+*> ZDOTC forms the dot product of two complex vectors
+*>      ZDOTC = X^H * Y
+*>
 *> \endverbatim
 *
 *  Authors:
Index: zdotu.f
===================================================================
--- zdotu.f   (revision 1579)
+++ zdotu.f   (working copy)
@@ -23,7 +23,9 @@
 *>
 *> \verbatim
 *>
-*>    ZDOTU forms the dot product of two vectors.
+*> ZDOTU forms the dot product of two complex vectors
+*>      ZDOTU = X^T * Y
+*>
 *> \endverbatim
 *


[zerothi]

Great, thanks.
Your description is much better than my suggested edit.
Surely the row/column order should be noted.