diff --git a/CMakeLists.txt b/CMakeLists.txt
index 08199e9a..e9546d56 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -6,7 +6,7 @@
######################################################################
# Required version
-cmake_minimum_required(VERSION 2.8.12)
+cmake_minimum_required(VERSION 3.9)
# Project Version
project(SuperLU C)
@@ -24,6 +24,7 @@ set(PROJECT_VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_BugFix})
set(USE_XSDK_DEFAULTS TRUE)
include(CTest)
include(GNUInstallDirs)
+include(FeatureSummary)
######################################################################
@@ -76,7 +77,7 @@ endif()
option(enable_internal_blaslib "Build the CBLAS library" ${enable_blaslib_DEFAULT})
option(enable_matlabmex "Build the Matlab mex library" OFF)
option(enable_tests "Build tests" ON)
-option(enable_doc "Build doxygen documentation" OFF)
+option(enable_doc "Add target 'doc' to build Doxygen documentation" OFF)
option(enable_single "Enable single precision library" ON)
option(enable_double "Enable double precision library" ON)
option(enable_complex "Enable complex precision library" ON)
@@ -215,8 +216,7 @@ if (XSDK_ENABLE_Fortran)
endif()
if(enable_doc)
- message(FATAL_ERROR "Documentation build requested but not implemented.")
- #implement doxygen
+ add_subdirectory(DOC)
endif()
# Generate various configure files with proper definitions
diff --git a/DOC/CMakeLists.txt b/DOC/CMakeLists.txt
new file mode 100644
index 00000000..a4bcc951
--- /dev/null
+++ b/DOC/CMakeLists.txt
@@ -0,0 +1,16 @@
+# build HTML documentation using Doxygen
+
+find_package(Doxygen)
+set_package_properties("Doxygen" PROPERTIES
+ DESCRIPTION "Documentation generator"
+ URL "www.doxygen.org"
+ PURPOSE "Generate HTML documentation from C sources")
+
+# set Doxygen options
+set(DOXYGEN_WARN_LOGFILE "doxygen.log")
+
+doxygen_add_docs(doc
+ "${PROJECT_SOURCE_DIR}/EXAMPLE"
+ "${PROJECT_SOURCE_DIR}/FORTRAN"
+ "${PROJECT_SOURCE_DIR}/SRC"
+ COMMENT "Generate HTML documentation with Doxygen")
diff --git a/EXAMPLE/sp_ienv.c b/EXAMPLE/sp_ienv.c
index a01e3a96..e7cf529c 100644
--- a/EXAMPLE/sp_ienv.c
+++ b/EXAMPLE/sp_ienv.c
@@ -8,7 +8,7 @@ All rights reserved.
The source code is distributed under BSD license, see the file License.txt
at the top-level directory.
*/
-/*! @file sp_ienv.c
+/*! @file EXAMPLE/sp_ienv.c
* \brief Chooses machine-dependent parameters for the local environment.
*
*
diff --git a/FORTRAN/c_fortran_cgssv.c b/FORTRAN/c_fortran_cgssv.c
index 9a255adb..6966434a 100644
--- a/FORTRAN/c_fortran_cgssv.c
+++ b/FORTRAN/c_fortran_cgssv.c
@@ -22,16 +22,7 @@ typedef struct {
int *perm_r;
} factors_t;
-void
-c_fortran_cgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
- complex *values, int_t *rowind, int_t *colptr,
- complex *b, int *ldb,
- fptr *f_factors, /* a handle containing the address
- pointing to the factored matrices */
- int_t *info)
-
-{
-/*
+/*!
* This routine can be called from Fortran.
*
* iopt (input) int
@@ -44,9 +35,15 @@ c_fortran_cgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
* If iopt == 1, it is an output and contains the pointer pointing to
* the structure of the factored matrices.
* Otherwise, it it an input.
- *
*/
-
+void
+c_fortran_cgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
+ complex *values, int_t *rowind, int_t *colptr,
+ complex *b, int *ldb,
+ fptr *f_factors, /* a handle containing the address
+ pointing to the factored matrices */
+ int_t *info)
+{
SuperMatrix A, AC, B;
SuperMatrix *L, *U;
int *perm_r; /* row permutations from partial pivoting */
diff --git a/FORTRAN/c_fortran_dgssv.c b/FORTRAN/c_fortran_dgssv.c
index 340e7d6b..80151ac0 100644
--- a/FORTRAN/c_fortran_dgssv.c
+++ b/FORTRAN/c_fortran_dgssv.c
@@ -22,16 +22,7 @@ typedef struct {
int *perm_r;
} factors_t;
-void
-c_fortran_dgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
- double *values, int_t *rowind, int_t *colptr,
- double *b, int *ldb,
- fptr *f_factors, /* a handle containing the address
- pointing to the factored matrices */
- int_t *info)
-
-{
-/*
+/*!
* This routine can be called from Fortran.
*
* iopt (input) int
@@ -44,9 +35,15 @@ c_fortran_dgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
* If iopt == 1, it is an output and contains the pointer pointing to
* the structure of the factored matrices.
* Otherwise, it it an input.
- *
*/
-
+void
+c_fortran_dgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
+ double *values, int_t *rowind, int_t *colptr,
+ double *b, int *ldb,
+ fptr *f_factors, /* a handle containing the address
+ pointing to the factored matrices */
+ int_t *info)
+{
SuperMatrix A, AC, B;
SuperMatrix *L, *U;
int *perm_r; /* row permutations from partial pivoting */
diff --git a/FORTRAN/c_fortran_sgssv.c b/FORTRAN/c_fortran_sgssv.c
index cedda3f3..53e13883 100644
--- a/FORTRAN/c_fortran_sgssv.c
+++ b/FORTRAN/c_fortran_sgssv.c
@@ -22,16 +22,7 @@ typedef struct {
int *perm_r;
} factors_t;
-void
-c_fortran_sgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
- float *values, int_t *rowind, int_t *colptr,
- float *b, int *ldb,
- fptr *f_factors, /* a handle containing the address
- pointing to the factored matrices */
- int_t *info)
-
-{
-/*
+/*!
* This routine can be called from Fortran.
*
* iopt (input) int
@@ -44,9 +35,15 @@ c_fortran_sgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
* If iopt == 1, it is an output and contains the pointer pointing to
* the structure of the factored matrices.
* Otherwise, it it an input.
- *
*/
-
+void
+c_fortran_sgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
+ float *values, int_t *rowind, int_t *colptr,
+ float *b, int *ldb,
+ fptr *f_factors, /* a handle containing the address
+ pointing to the factored matrices */
+ int_t *info)
+{
SuperMatrix A, AC, B;
SuperMatrix *L, *U;
int *perm_r; /* row permutations from partial pivoting */
diff --git a/FORTRAN/c_fortran_zgssv.c b/FORTRAN/c_fortran_zgssv.c
index 75d400ca..9cf841bd 100644
--- a/FORTRAN/c_fortran_zgssv.c
+++ b/FORTRAN/c_fortran_zgssv.c
@@ -22,16 +22,7 @@ typedef struct {
int *perm_r;
} factors_t;
-void
-c_fortran_zgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
- doublecomplex *values, int_t *rowind, int_t *colptr,
- doublecomplex *b, int *ldb,
- fptr *f_factors, /* a handle containing the address
- pointing to the factored matrices */
- int_t *info)
-
-{
-/*
+/*!
* This routine can be called from Fortran.
*
* iopt (input) int
@@ -44,9 +35,15 @@ c_fortran_zgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
* If iopt == 1, it is an output and contains the pointer pointing to
* the structure of the factored matrices.
* Otherwise, it it an input.
- *
*/
-
+void
+c_fortran_zgssv_(int *iopt, int *n, int_t *nnz, int *nrhs,
+ doublecomplex *values, int_t *rowind, int_t *colptr,
+ doublecomplex *b, int *ldb,
+ fptr *f_factors, /* a handle containing the address
+ pointing to the factored matrices */
+ int_t *info)
+{
SuperMatrix A, AC, B;
SuperMatrix *L, *U;
int *perm_r; /* row permutations from partial pivoting */
diff --git a/SRC/ccolumn_bmod.c b/SRC/ccolumn_bmod.c
index 77ed83c8..fa96b198 100644
--- a/SRC/ccolumn_bmod.c
+++ b/SRC/ccolumn_bmod.c
@@ -43,7 +43,7 @@ at the top-level directory.
* ========
* Performs numeric block updates (sup-col) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
* Return value: 0 - successful return
* > 0 - number of bytes allocated when run out of space
*
diff --git a/SRC/cgsisx.c b/SRC/cgsisx.c
index a02cbb98..63f476f7 100644
--- a/SRC/cgsisx.c
+++ b/SRC/cgsisx.c
@@ -21,7 +21,8 @@ at the top-level directory.
*/
#include "slu_cdefs.h"
-/*! \brief
+/*!
+ * Computes approximate solutions using the ILU factorization from cgsitrf()
*
*
* Purpose
@@ -373,7 +374,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/cgssvx.c b/SRC/cgssvx.c
index 12bc2300..04635823 100644
--- a/SRC/cgssvx.c
+++ b/SRC/cgssvx.c
@@ -21,7 +21,9 @@ at the top-level directory.
*/
#include "slu_cdefs.h"
-/*! \brief
+/*!
+ * Solves the system of linear equations using
+ * the LU factorization from cgstrf()
*
*
* Purpose
@@ -324,7 +326,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/cmemory.c b/SRC/cmemory.c
index f6971788..53fcfd9e 100644
--- a/SRC/cmemory.c
+++ b/SRC/cmemory.c
@@ -98,15 +98,14 @@ void cuser_free(int bytes, int which_end, GlobalLU_t *Glu)
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int cQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -136,15 +135,14 @@ int cQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
} /* cQuerySpace */
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int ilu_cQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
diff --git a/SRC/cmyblas2.c b/SRC/cmyblas2.c
index 9840fea6..2772e171 100644
--- a/SRC/cmyblas2.c
+++ b/SRC/cmyblas2.c
@@ -18,6 +18,7 @@ at the top-level directory.
* and Lawrence Berkeley National Lab.
* November 15, 1997
*
+ *
* Purpose:
* Level 2 BLAS operations: solves and matvec, written in C.
* Note:
diff --git a/SRC/cpanel_bmod.c b/SRC/cpanel_bmod.c
index cc46ce30..f6e46694 100644
--- a/SRC/cpanel_bmod.c
+++ b/SRC/cpanel_bmod.c
@@ -46,7 +46,7 @@ at the top-level directory.
*
* Performs numeric block updates (sup-panel) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
*
* Before entering this routine, the original nonzeros in the panel
* were already copied into the spa[m,w].
diff --git a/SRC/creadrb.c b/SRC/creadrb.c
index fb21ba5f..1b301d9d 100644
--- a/SRC/creadrb.c
+++ b/SRC/creadrb.c
@@ -17,6 +17,7 @@ at the top-level directory.
* Lawrence Berkeley National Laboratory.
* June 30, 2009
*
+ *
*
* Purpose
* =======
diff --git a/SRC/dcolumn_bmod.c b/SRC/dcolumn_bmod.c
index eecc0a3d..8bcf0e42 100644
--- a/SRC/dcolumn_bmod.c
+++ b/SRC/dcolumn_bmod.c
@@ -43,7 +43,7 @@ at the top-level directory.
* ========
* Performs numeric block updates (sup-col) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
* Return value: 0 - successful return
* > 0 - number of bytes allocated when run out of space
*
diff --git a/SRC/dgsisx.c b/SRC/dgsisx.c
index dd12d859..35b3fa02 100644
--- a/SRC/dgsisx.c
+++ b/SRC/dgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/dgssvx.c b/SRC/dgssvx.c
index 489798d0..5bee0a36 100644
--- a/SRC/dgssvx.c
+++ b/SRC/dgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/dmemory.c b/SRC/dmemory.c
index 3b7880ad..0348a703 100644
--- a/SRC/dmemory.c
+++ b/SRC/dmemory.c
@@ -47,7 +47,7 @@ extern void user_bcopy (char *, char *, int);
/*! \brief Setup the memory model to be used for factorization.
- *
+ *
* lwork = 0: use system malloc;
* lwork > 0: use user-supplied work[] space.
*/
@@ -98,15 +98,14 @@ void duser_free(int bytes, int which_end, GlobalLU_t *Glu)
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int dQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -136,15 +135,14 @@ int dQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
} /* dQuerySpace */
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int ilu_dQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -333,8 +331,11 @@ dLUMemInit(fact_t fact, void *work, int_t lwork, int m, int n, int_t annz,
} /* dLUMemInit */
-/*! \brief Allocate known working storage. Returns 0 if success, otherwise
- returns the number of bytes allocated so far when failure occurred. */
+/*! \brief Allocate known working storage.
+ *
+ * Returns 0 if success, otherwise
+ * returns the number of bytes allocated so far when failure occurred.
+ */
int
dLUWorkInit(int m, int n, int panel_size, int **iworkptr,
double **dworkptr, GlobalLU_t *Glu)
diff --git a/SRC/dmyblas2.c b/SRC/dmyblas2.c
index 9e94c92c..ad8ea03a 100644
--- a/SRC/dmyblas2.c
+++ b/SRC/dmyblas2.c
@@ -18,6 +18,7 @@ at the top-level directory.
* and Lawrence Berkeley National Lab.
* November 15, 1997
*
+ *
* Purpose:
* Level 2 BLAS operations: solves and matvec, written in C.
* Note:
diff --git a/SRC/dpanel_bmod.c b/SRC/dpanel_bmod.c
index e4b958e6..a4403917 100644
--- a/SRC/dpanel_bmod.c
+++ b/SRC/dpanel_bmod.c
@@ -46,7 +46,7 @@ at the top-level directory.
*
* Performs numeric block updates (sup-panel) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
*
* Before entering this routine, the original nonzeros in the panel
* were already copied into the spa[m,w].
diff --git a/SRC/dreadrb.c b/SRC/dreadrb.c
index 53fccd77..6f848134 100644
--- a/SRC/dreadrb.c
+++ b/SRC/dreadrb.c
@@ -17,6 +17,7 @@ at the top-level directory.
* Lawrence Berkeley National Laboratory.
* June 30, 2009
*
+ *
*
* Purpose
* =======
diff --git a/SRC/mark_relax.c b/SRC/mark_relax.c
index 6523a98d..7dc9d3eb 100644
--- a/SRC/mark_relax.c
+++ b/SRC/mark_relax.c
@@ -15,7 +15,7 @@ at the top-level directory.
* -- SuperLU routine (version 4.0) --
* Lawrence Berkeley National Laboratory
* June 1, 2009
- * <\pre>
+ *
*/
#include "slu_ddefs.h"
diff --git a/SRC/scolumn_bmod.c b/SRC/scolumn_bmod.c
index ec41f0c6..4381e10c 100644
--- a/SRC/scolumn_bmod.c
+++ b/SRC/scolumn_bmod.c
@@ -43,7 +43,7 @@ at the top-level directory.
* ========
* Performs numeric block updates (sup-col) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
* Return value: 0 - successful return
* > 0 - number of bytes allocated when run out of space
*
@@ -263,7 +263,7 @@ scolumn_bmod (
} /* for each segment... */
/*
- * Process the supernodal portion of L\U[*,j]
+ * Process the supernodal portion of L\\U[*,j]
*/
nextlu = xlusup[jcol];
fsupc = xsup[jsupno];
diff --git a/SRC/sgsisx.c b/SRC/sgsisx.c
index 499ec7d8..92c2584e 100644
--- a/SRC/sgsisx.c
+++ b/SRC/sgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/sgssvx.c b/SRC/sgssvx.c
index 6cc19b7c..1395752d 100644
--- a/SRC/sgssvx.c
+++ b/SRC/sgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/slu_sdefs.h b/SRC/slu_sdefs.h
index 99eed2d5..9bb6a38e 100644
--- a/SRC/slu_sdefs.h
+++ b/SRC/slu_sdefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
*
* Global data structures used in LU factorization -
*
- * nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ * nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
* (xsup,supno): supno[i] is the supernode no to which i belongs;
* xsup(s) points to the beginning of the s-th supernode.
* e.g. supno 0 1 2 2 3 3 3 4 4 4 4 4 (n=12)
diff --git a/SRC/slu_zdefs.h b/SRC/slu_zdefs.h
index a36abd86..ba5d8636 100644
--- a/SRC/slu_zdefs.h
+++ b/SRC/slu_zdefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
*
* Global data structures used in LU factorization -
*
- * nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ * nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
* (xsup,supno): supno[i] is the supernode no to which i belongs;
* xsup(s) points to the beginning of the s-th supernode.
* e.g. supno 0 1 2 2 3 3 3 4 4 4 4 4 (n=12)
diff --git a/SRC/smemory.c b/SRC/smemory.c
index e0ccd3fb..17d4e1b8 100644
--- a/SRC/smemory.c
+++ b/SRC/smemory.c
@@ -47,7 +47,7 @@ extern void user_bcopy (char *, char *, int);
/*! \brief Setup the memory model to be used for factorization.
- *
+ *
* lwork = 0: use system malloc;
* lwork > 0: use user-supplied work[] space.
*/
@@ -98,15 +98,14 @@ void suser_free(int bytes, int which_end, GlobalLU_t *Glu)
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int sQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -136,15 +135,14 @@ int sQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
} /* sQuerySpace */
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int ilu_sQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -333,8 +331,12 @@ sLUMemInit(fact_t fact, void *work, int_t lwork, int m, int n, int_t annz,
} /* sLUMemInit */
-/*! \brief Allocate known working storage. Returns 0 if success, otherwise
- returns the number of bytes allocated so far when failure occurred. */
+/*! \brief Allocate known working storage.
+ *
+ * Returns 0 if success, otherwise returns the number of bytes allocated
+ * so far when failure occurred.
+ */
+
int
sLUWorkInit(int m, int n, int panel_size, int **iworkptr,
float **dworkptr, GlobalLU_t *Glu)
diff --git a/SRC/smyblas2.c b/SRC/smyblas2.c
index 1d5c9112..ace2bee2 100644
--- a/SRC/smyblas2.c
+++ b/SRC/smyblas2.c
@@ -18,6 +18,7 @@ at the top-level directory.
* and Lawrence Berkeley National Lab.
* November 15, 1997
*
+ *
* Purpose:
* Level 2 BLAS operations: solves and matvec, written in C.
* Note:
diff --git a/SRC/sp_ienv.c b/SRC/sp_ienv.c
index 92159fba..804207c2 100644
--- a/SRC/sp_ienv.c
+++ b/SRC/sp_ienv.c
@@ -8,7 +8,7 @@ All rights reserved.
The source code is distributed under BSD license, see the file License.txt
at the top-level directory.
*/
-/*! @file sp_ienv.c
+/*! @file SRC/sp_ienv.c
* \brief Chooses machine-dependent parameters for the local environment.
*
*
diff --git a/SRC/spanel_bmod.c b/SRC/spanel_bmod.c
index 0e0936b5..9a2d8064 100644
--- a/SRC/spanel_bmod.c
+++ b/SRC/spanel_bmod.c
@@ -46,7 +46,7 @@ at the top-level directory.
*
* Performs numeric block updates (sup-panel) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
*
* Before entering this routine, the original nonzeros in the panel
* were already copied into the spa[m,w].
diff --git a/SRC/sreadrb.c b/SRC/sreadrb.c
index fe3e92fb..5947c263 100644
--- a/SRC/sreadrb.c
+++ b/SRC/sreadrb.c
@@ -17,6 +17,7 @@ at the top-level directory.
* Lawrence Berkeley National Laboratory.
* June 30, 2009
*
+ *
*
* Purpose
* =======
diff --git a/SRC/zcolumn_bmod.c b/SRC/zcolumn_bmod.c
index 92989116..d445dcc2 100644
--- a/SRC/zcolumn_bmod.c
+++ b/SRC/zcolumn_bmod.c
@@ -43,7 +43,7 @@ at the top-level directory.
* ========
* Performs numeric block updates (sup-col) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
* Return value: 0 - successful return
* > 0 - number of bytes allocated when run out of space
*
diff --git a/SRC/zgsisx.c b/SRC/zgsisx.c
index bacbadc5..57c5d7b4 100644
--- a/SRC/zgsisx.c
+++ b/SRC/zgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/zgssvx.c b/SRC/zgssvx.c
index 7054c08e..e9d8e441 100644
--- a/SRC/zgssvx.c
+++ b/SRC/zgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
* mem_usage (output) mem_usage_t*
* Record the memory usage statistics, consisting of following fields:
* - for_lu (float)
- * The amount of space used in bytes for L\U data structures.
+ * The amount of space used in bytes for L\\U data structures.
* - total_needed (float)
* The amount of space needed in bytes to perform factorization.
* - expansions (int)
diff --git a/SRC/zmemory.c b/SRC/zmemory.c
index 7fb59987..8c27349d 100644
--- a/SRC/zmemory.c
+++ b/SRC/zmemory.c
@@ -47,7 +47,7 @@ extern void user_bcopy (char *, char *, int);
/*! \brief Setup the memory model to be used for factorization.
- *
+ *
* lwork = 0: use system malloc;
* lwork > 0: use user-supplied work[] space.
*/
@@ -98,15 +98,14 @@ void zuser_free(int bytes, int which_end, GlobalLU_t *Glu)
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int zQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -136,15 +135,14 @@ int zQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
} /* zQuerySpace */
-/*! \brief
+/*!
+ * Calculate memory usage
*
- *
- * mem_usage consists of the following fields:
- * - for_lu (float)
- * The amount of space used in bytes for the L\U data structures.
- * - total_needed (float)
+ * \param mem_usage consists of the following fields:
+ * - for_lu (float)
+ * The amount of space used in bytes for the L\\U data structures.
+ * - total_needed (float)
* The amount of space needed in bytes to perform factorization.
- *
*/
int ilu_zQuerySpace(SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage)
{
@@ -333,8 +331,12 @@ zLUMemInit(fact_t fact, void *work, int_t lwork, int m, int n, int_t annz,
} /* zLUMemInit */
-/*! \brief Allocate known working storage. Returns 0 if success, otherwise
- returns the number of bytes allocated so far when failure occurred. */
+/*! \brief Allocate known working storage.
+ *
+ * Returns 0 if success, otherwise returns the number of bytes
+ * allocated so far when failure occurred.
+*/
+
int
zLUWorkInit(int m, int n, int panel_size, int **iworkptr,
doublecomplex **dworkptr, GlobalLU_t *Glu)
diff --git a/SRC/zmyblas2.c b/SRC/zmyblas2.c
index 41a23ab4..adfffc9b 100644
--- a/SRC/zmyblas2.c
+++ b/SRC/zmyblas2.c
@@ -18,6 +18,7 @@ at the top-level directory.
* and Lawrence Berkeley National Lab.
* November 15, 1997
*
+ *
* Purpose:
* Level 2 BLAS operations: solves and matvec, written in C.
* Note:
diff --git a/SRC/zpanel_bmod.c b/SRC/zpanel_bmod.c
index 72c84889..a41bbcaa 100644
--- a/SRC/zpanel_bmod.c
+++ b/SRC/zpanel_bmod.c
@@ -46,7 +46,7 @@ at the top-level directory.
*
* Performs numeric block updates (sup-panel) in topological order.
* It features: col-col, 2cols-col, 3cols-col, and sup-col updates.
- * Special processing on the supernodal portion of L\U[*,j]
+ * Special processing on the supernodal portion of L\\U[*,j]
*
* Before entering this routine, the original nonzeros in the panel
* were already copied into the spa[m,w].
diff --git a/SRC/zreadrb.c b/SRC/zreadrb.c
index e18836b6..6b56c52d 100644
--- a/SRC/zreadrb.c
+++ b/SRC/zreadrb.c
@@ -17,6 +17,7 @@ at the top-level directory.
* Lawrence Berkeley National Laboratory.
* June 30, 2009
*
+ *
*
* Purpose
* =======