summaryrefslogtreecommitdiff
path: root/DOCS
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2012-08-10 17:32:23 +0000
committerjulie <julielangou@users.noreply.github.com>2012-08-10 17:32:23 +0000
commitf19e60eae7501b29b32121b21313585dfe46cf3b (patch)
tree9935b3b772c97bf7538a0a9d7b28cfdb6cb86a6a /DOCS
parenteca2d3e81e78f3decb20f86a9462ef9a3f49d7c3 (diff)
downloadlapack-f19e60eae7501b29b32121b21313585dfe46cf3b.tar.gz
lapack-f19e60eae7501b29b32121b21313585dfe46cf3b.tar.bz2
lapack-f19e60eae7501b29b32121b21313585dfe46cf3b.zip
Correct comments and Doxygen generation following comments from Sa-Lin Cheng Bernstein sent to lapack mailing list on August 9th 2012
While looking at the new lapack version (v3.4.1) and going through the routines on http://www.netlib.org/lapack/lapack_routine/, we found some errors and thought that we should report them. Below is the list of the errors. ==================================================================== (1) Should be "\ingroup complex16OTHERsolve" and not "\ingroup complex16OTHERcomputational" because they are driver routines; in addition, in the line just below SUBROUTINE <routinename>, it should be driver routine: sgtsv.f sgtsvx.f sptsv.f sptsvx.f dgtsv.f dgtsvx.f dptsv.f dptsvx.f cgtsv.f cgtsvx.f cptsv.f cptsvx.f zgtsv.f zgtsvx.f zptsv.f zptsvx.f (2) Should be "\ingroup complex16SYsolve" and not "\ingroup complex16OTHERcomputational" because they are driver routines; in addition, in the line just below SUBROUTINE <routinename>, it should be driver routine: ssysvxx.f dsysvxx.f (3) Should be "\ingroup realOTHERcomputational" and not ""\ingroup auxOTHERcomputational": spttrf.f (4) Should be "\ingroup doubleOTHERcomputational" and not ""\ingroup auxOTHERcomputational": dpttrf.f (5) Should be "symmetric matrix" and not "Hermitian indefinite matrix" in "\par Purpose:" ssytri2.f dsytri2.f csytri2.f zsytri2.f (6) Should be "\ingroup realGEsing" and not "\ingroup realGEcomputational": sgejsv.f dgejsv.f
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/Doxyfile2
-rw-r--r--DOCS/groups-usr.dox84
2 files changed, 85 insertions, 1 deletions
diff --git a/DOCS/Doxyfile b/DOCS/Doxyfile
index 320db7fa..9098aa87 100644
--- a/DOCS/Doxyfile
+++ b/DOCS/Doxyfile
@@ -32,7 +32,7 @@ PROJECT_NAME = LAPACK
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 3.4.1
+PROJECT_NUMBER = 3.4.2
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
diff --git a/DOCS/groups-usr.dox b/DOCS/groups-usr.dox
index 074ce29f..feb134f1 100644
--- a/DOCS/groups-usr.dox
+++ b/DOCS/groups-usr.dox
@@ -17,6 +17,12 @@
* @defgroup PO Positive Definite Matrix
* @ingroup lapack
* This is the group of Positive Definite routines
+ * @defgroup GT General tridiagonal Matrix
+ * @ingroup lapack
+ * This is the group of General tridiagonal routines
+ * @defgroup PT Positive Definite tridiagonal Matrix
+ * @ingroup lapack
+ * This is the group of Positive Definite tridiagonal routines
* @defgroup auxOTHERauxiliary Other Auxiliary Routines
* @ingroup lapack
* This is the group of Other Auxiliary routines
@@ -35,6 +41,12 @@
* @defgroup solvePO Linear Solve
* @ingroup PO
* This is the group of Linear Solve Driver routines
+ * @defgroup solveGT Linear Solve
+ * @ingroup GT
+ * This is the group of Linear Solve Driver routines
+ * @defgroup solvePT Linear Solve
+ * @ingroup PT
+ * This is the group of Linear Solve Driver routines
* @defgroup eigenGE Eigenvalue
* @ingroup GE
* This is the group of Eigenvalue Driver routines
@@ -56,6 +68,12 @@
* @defgroup computationalPO Computational routines
* @ingroup PO
* This is the group of Computational routines
+ * @defgroup computationalGT Computational routines
+ * @ingroup GT
+ * This is the group of Computational routines
+ * @defgroup computationalPT Computational routines
+ * @ingroup PT
+ * This is the group of Computational routines
* @defgroup auxiliaryGE Auxiliary routines
* @ingroup GE
* This is the group of Auxiliary routines
@@ -68,6 +86,12 @@
* @defgroup auxiliaryPO Auxiliary routines
* @ingroup PO
* This is the group of Auxiliary routines
+ * @defgroup auxiliaryGT Auxiliary routines
+ * @ingroup GT
+ * This is the group of Auxiliary routines
+ * @defgroup auxiliaryPT Auxiliary routines
+ * @ingroup PT
+ * This is the group of Auxiliary routines
*
****
*
@@ -83,6 +107,12 @@
* @defgroup doubleGBsolve double
* @ingroup solveGB
* This is the group of double solve driver functions for GB matrices
+ * @defgroup doubleGTsolve double
+ * @ingroup solveGT
+ * This is the group of double solve driver functions for GT matrices
+ * @defgroup doublePTsolve double
+ * @ingroup solvePT
+ * This is the group of double solve driver functions for PT matrices
* @defgroup doubleGEeigen double
* @ingroup eigenGE
* This is the group of double eigenvalue driver functions for GE matrices
@@ -104,6 +134,12 @@
* @defgroup doubleGBcomputational double
* @ingroup computationalGB
* This is the group of double computational functions for GB matrices
+ * @defgroup doubleGTcomputational double
+ * @ingroup computationalGT
+ * This is the group of double computational functions for GT matrices
+ * @defgroup doublePTcomputational double
+ * @ingroup computationalPT
+ * This is the group of double computational functions for PT matrices
* @defgroup doubleGEauxiliary double
* @ingroup auxiliaryGE
* This is the group of double auxiliary functions for GE matrices
@@ -116,6 +152,12 @@
* @defgroup doubleGBauxiliary double
* @ingroup auxiliaryGB
* This is the group of double auxiliary functions for GB matrices
+ * @defgroup doublePTauxiliary double
+ * @ingroup auxiliaryPT
+ * This is the group of double auxiliary functions for PT matrices
+ * @defgroup doubleGTauxiliary double
+ * @ingroup auxiliaryGT
+ * This is the group of double auxiliary functions for GT matrices
*
****
*
@@ -131,6 +173,12 @@
* @defgroup realGBsolve real
* @ingroup solveGB
* This is the group of real solve driver functions for GB matrices
+ * @defgroup realGTsolve real
+ * @ingroup solveGT
+ * This is the group of real solve driver functions for GT matrices
+ * @defgroup realPTsolve real
+ * @ingroup solvePT
+ * This is the group of real solve driver functions for PT matrices
* @defgroup realGEeigen real
* @ingroup eigenGE
* This is the group of real eigenvalue driver functions for GE matrices
@@ -152,6 +200,12 @@
* @defgroup realGBcomputational real
* @ingroup computationalGB
* This is the group of real computational functions for GB matrices
+ * @defgroup realPTcomputational real
+ * @ingroup computationalPT
+ * This is the group of real computational functions for PT matrices
+ * @defgroup realGTcomputational real
+ * @ingroup computationalGT
+ * This is the group of real computational functions for GT matrices
* @defgroup realGEauxiliary real
* @ingroup auxiliaryGE
* This is the group of real auxiliary functions for GE matrices
@@ -164,6 +218,12 @@
* @defgroup realGBauxiliary real
* @ingroup auxiliaryGB
* This is the group of real auxiliary functions for GB matrices
+ * @defgroup realGTauxiliary real
+ * @ingroup auxiliaryGT
+ * This is the group of real auxiliary functions for GT matrices
+ * @defgroup realPTauxiliary real
+ * @ingroup auxiliaryPT
+ * This is the group of real auxiliary functions for PT matrices
*
****
*
@@ -179,6 +239,12 @@
* @defgroup complexGBsolve complex
* @ingroup solveGB
* This is the group of complex solve driver functions for GB matrices
+ * @defgroup complexGTsolve complex
+ * @ingroup solveGT
+ * This is the group of complex solve driver functions for GT matrices
+ * @defgroup complexPTsolve complex
+ * @ingroup solvePT
+ * This is the group of complex solve driver functions for PT matrices
* @defgroup complexGEeigen complex
* @ingroup eigenGE
* This is the group of complex eigenvalue driver functions for GE matrices
@@ -200,6 +266,12 @@
* @defgroup complexGBcomputational complex
* @ingroup computationalGB
* This is the group of complex computational functions for GB matrices
+ * @defgroup complexGTcomputational complex
+ * @ingroup computationalGT
+ * This is the group of complex computational functions for GT matrices
+ * @defgroup complexPTcomputational complex
+ * @ingroup computationalPT
+ * This is the group of complex computational functions for PT matrices
* @defgroup complexGEauxiliary complex
* @ingroup auxiliaryGE
* This is the group of complex auxiliary functions for GE matrices
@@ -227,6 +299,12 @@
* @defgroup complex16GBsolve complex16
* @ingroup solveGB
* This is the group of complex16 solve driver functions for GB matrices
+ * @defgroup complex16GTsolve complex16
+ * @ingroup solveGT
+ * This is the group of complex16 solve driver functions for GT matrices
+ * @defgroup complex16PTsolve complex16
+ * @ingroup solvePT
+ * This is the group of complex16 solve driver functions for PT matrices
* @defgroup complex16GEeigen complex16
* @ingroup eigenGE
* This is the group of complex16 eigenvalue driver functions for GE matrices
@@ -248,6 +326,12 @@
* @defgroup complex16GBcomputational complex16
* @ingroup computationalGB
* This is the group of complex16 computational functions for GB matrices
+ * @defgroup complex16GTcomputational complex16
+ * @ingroup computationalGT
+ * This is the group of complex16 computational functions for GT matrices
+ * @defgroup complex16PTcomputational complex16
+ * @ingroup computationalPT
+ * This is the group of complex16 computational functions for PT matrices
* @defgroup complex16GEauxiliary complex16
* @ingroup auxiliaryGE
* This is the group of complex16 auxiliary functions for GE matrices