ParU 0.1.0: version update, various fixes

Author: DrTimothyAldenDavis

ParU/CMakeLists.txt

@@ -13,9 +13,9 @@
 # cmake 3.22 is required to find the BLAS in SuiteSparse_config
 cmake_minimum_required ( VERSION 3.22 )
 
-set ( PARU_DATE "Dec 20, 2022" )    # FIXME: pick a date
-set ( PARU_VERSION_MAJOR 1 CACHE STRING "" FORCE )
-set ( PARU_VERSION_MINOR 0 CACHE STRING "" FORCE )
+set ( PARU_DATE "Dec 30, 2023" )
+set ( PARU_VERSION_MAJOR  0 CACHE STRING "" FORCE )
+set ( PARU_VERSION_MINOR  1 CACHE STRING "" FORCE )
 set ( PARU_VERSION_UPDATE 0 CACHE STRING "" FORCE )
 
 message ( STATUS "Building PARU version: v"
@@ -71,22 +71,22 @@ else ( )
 endif ( )
 
 if ( NOT SUITESPARSE_ROOT_CMAKELISTS )
-    find_package ( SuiteSparse_config 7.3.0
+    find_package ( SuiteSparse_config 7.4.0
         PATHS ${CMAKE_SOURCE_DIR}/../SuiteSparse_config/build NO_DEFAULT_PATH )
     if ( NOT TARGET SuiteSparse::SuiteSparseConfig )
-        find_package ( SuiteSparse_config 7.3.0 REQUIRED )
+        find_package ( SuiteSparse_config 7.4.0 REQUIRED )
     endif ( )
 
-    find_package ( CHOLMOD 5.0.0
+    find_package ( CHOLMOD 5.1.0
         PATHS ${CMAKE_SOURCE_DIR}/../CHOLMOD/build NO_DEFAULT_PATH )
     if ( NOT CHOLMOD_FOUND )
-        find_package ( CHOLMOD 5.0.0 REQUIRED )
+        find_package ( CHOLMOD 5.1.0 REQUIRED )
     endif ( )
 
-    find_package ( UMFPACK 6.2.2
+    find_package ( UMFPACK 6.3.0
         PATHS ${CMAKE_SOURCE_DIR}/../UMFPACK/build NO_DEFAULT_PATH )
     if ( NOT CAMD_FOUND )
-        find_package ( UMFPACK 6.2.2 REQUIRED )
+        find_package ( UMFPACK 6.3.0 REQUIRED )
     endif ( )
 endif ( )
 

ParU/Doc/ChangeLog

@@ -0,0 +1,4 @@
+Dec 30, 2023: version 0.1.0
+
+    * first release: in SuiteSparse 7.4.0
+

ParU/Doc/LICENSE renamed to ParU/Doc/License.txt

@@ -1,4 +1,5 @@
 \documentclass[12pt]{article}
+\batchmode
 \usepackage{hyperref}
 \usepackage{minted}
 

ParU/Doc/paru_user_guide.pdf

@@ -1,2 +1,2 @@
 % version of SuiteSparse/ParU
-\date{VERSION 1.0.0, Dec 20, 2022}
+\date{VERSION 0.1.0, Dec 30, 2023}

ParU/Doc/paru_user_guide.tex

@@ -25,9 +25,9 @@ typedef enum ParU_Ret
 
 #define PARU_MEM_CHUNK (1024*1024)
 
-#define PARU_DATE "Dec 20, 2022"
-#define PARU_VERSION_MAJOR  1
-#define PARU_VERSION_MINOR  0
+#define PARU_DATE "Dec 30, 2023"
+#define PARU_VERSION_MAJOR  0
+#define PARU_VERSION_MINOR  1
 #define PARU_VERSION_UPDATE 0
 
 //  the same values as UMFPACK_STRATEGY defined in UMFPACK/Include/umfpack.h

ParU/Doc/paru_version.tex

@@ -2,7 +2,8 @@
 // ParU/MATLAB/paru: MATLAB interface to ParU x=A\b
 //------------------------------------------------------------------------------
 
-// ParU Copyright (c) FIXME
+// ParU Copyright (c) 2023, Mohsen Aznaveh and Timothy A. Davis, 
+// All Rights Reserved.
 // SPDX-License-Identifier: GPL-3.0+
 
 //------------------------------------------------------------------------------

ParU/Include/ParU_definitions.h

@@ -1,16 +1,24 @@
 # SuiteSparse:ParU
 
-ParU, Copyright (c) 2022, Mohsen Aznaveh and Timothy A. Davis,
+ParU, Copyright (c) 2022-2023, Mohsen Aznaveh and Timothy A. Davis,
 All Rights Reserved.
 SPDX-License-Identifier: GNU GPL 3.0
 
 --------------------------------------------------------------------------------
 
+## NOTE: This is a pre-release of ParU, not yet version 1.0.
+
+There are several FIXME's and TODO's in the code we need to resolv for the
+final version, and the API may change in the final stable v1.0 version.
+
+Stay tuned.
+
 ## Introduction
 
 ParU: is a set of routings for solving sparse linear system via parallel
 multifrontal LU factorization algorithms.  Requires OpenMP 4.0+, BLAS, CHOLMOD,
-UMFPACK, AMD, COLAMD, CAMD, CCOLAMD, and METIS.
+UMFPACK, AMD, COLAMD, CAMD, CCOLAMD, and METIS (in particular, the
+CHOLMOD/SuiteSparse_metis variant; see the CHOLMOD documentation for details).
 
 ##  How to install
 
@@ -39,7 +47,7 @@ See Demo for more examples.
 
 --------------------------------------------------------------------------------
 ## License
-Copyright (C) 2022 Mohsen Aznaveh and Timothy A. Davis
+Copyright (C) 2022-2023 Mohsen Aznaveh and Timothy A. Davis
 
 This program is free software: you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software

ParU/MATLAB/paru.cpp

@@ -94,7 +94,6 @@ ParU_Ret paru_exec_tasks_seq(int64_t t, int64_t *task_num_child, paru_work *Work
 ParU_Ret paru_exec_tasks(int64_t t, int64_t *task_num_child, int64_t &chain_task,
                          paru_work *Work, ParU_Numeric *Num)
 {
-    DEBUGLEVEL(0);    // FIXME
     ParU_Symbolic *Sym = Work->Sym;
     int64_t *task_parent = Sym->task_parent;
     int64_t daddy = task_parent[t];
@@ -193,7 +192,6 @@ ParU_Ret paru_exec_tasks(int64_t t, int64_t *task_num_child, int64_t &chain_task
 ParU_Ret ParU_Factorize(cholmod_sparse *A, ParU_Symbolic *Sym,
                         ParU_Numeric **Num_handle, ParU_Control *user_Control)
 {
-    DEBUGLEVEL(0);    // FIXME
     PARU_DEFINE_PRLEVEL;
 #ifndef NTIME
     double my_start_time = PARU_OPENMP_GET_WTIME;
@@ -348,7 +346,6 @@ ParU_Ret ParU_Factorize(cholmod_sparse *A, ParU_Symbolic *Sym,
     // Use the sequential factorization unconditionally in that case.
     if (task_Q.size() * 2 > Control->paru_max_threads)
     {
-        printf ("Parallel:\n") ;    // FIXME
         PRLEVEL(1, ("Parallel\n"));
         // chekcing user input
         PRLEVEL(1, ("Control: max_th=" LD " scale=" LD " piv_toler=%lf "
@@ -373,13 +370,11 @@ ParU_Ret ParU_Factorize(cholmod_sparse *A, ParU_Symbolic *Sym,
         int64_t start = 0;
         PRLEVEL(
             1, ("%% size=" LD ", steps =" LD ", stages =" LD "\n", size, steps, stages));
-        printf ("stages " LD "\n", stages) ;    // FIXME
 
         for (int64_t ii = 0; ii < stages; ii++)
         {
             if (start >= size) break;
             int64_t end = start + steps > size ? size : start + steps;
-            printf ("stage " LD "\n", ii) ; // FIXME
             PRLEVEL(1, ("%% doing Queue tasks <" LD "," LD ">\n", start, end));
             #pragma omp parallel proc_bind(spread)                             \
             num_threads(Control->paru_max_threads)
@@ -417,7 +412,6 @@ ParU_Ret ParU_Factorize(cholmod_sparse *A, ParU_Symbolic *Sym,
         {
             #pragma omp atomic write
             Work->naft = 1;
-            printf ("remaining " LD "\n", chain_task) ; // FIXME
             PRLEVEL(1, ("Chain_taskd " LD " has remained\n", chain_task));
             info = paru_exec_tasks_seq(chain_task, task_num_child, Work, Num);
         }
@@ -461,7 +455,6 @@ ParU_Ret ParU_Factorize(cholmod_sparse *A, ParU_Symbolic *Sym,
     // finalize the permutation
     //--------------------------------------------------------------------------
 
-    printf ("finalize permutation\n") ; // FIXME
     PRLEVEL(1, ("finalize permutation\n"));
     info = paru_finalize_perm(Sym, Num);  // to form the final permutation
     paru_free_work(Sym, Work);   // free the work DS