Skip to content

Commit

Permalink
ParU FIXMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
DrTimothyAldenDavis committed May 23, 2024
1 parent 36bacec commit a77a225
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion ParU/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# cmake 3.22 is required to find the BLAS in SuiteSparse_config
cmake_minimum_required ( VERSION 3.22 )

set ( PARU_DATE "Apr XX, 2024" ) # FIXME
set ( PARU_DATE "Apr XX, 2024" ) # FIXME NOW
set ( PARU_VERSION_MAJOR 1 CACHE STRING "" FORCE )
set ( PARU_VERSION_MINOR 0 CACHE STRING "" FORCE )
set ( PARU_VERSION_UPDATE 0 CACHE STRING "" FORCE )
Expand Down
2 changes: 1 addition & 1 deletion ParU/Doc/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
May XX, 2024: version 1.0.0 FIXME
May XX, 2024: version 1.0.0 FIXME NOW

* major changes to the API: as compared to the draft 0.1 version.
* first stable release
Expand Down
2 changes: 1 addition & 1 deletion ParU/Doc/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
Files in this folder:

ChangeLog log of changes to ParU
Doxyfile FIXME: delete this?
Doxyfile FIXME NOW: delete this?
Makefile "make" will create the user guide PDF
paru_user_guide.bib references for the user guide
paru_user_guide.pdf PDF version of the user guide
Expand Down
8 changes: 4 additions & 4 deletions ParU/Doc/paru_user_guide.tex
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ \section{Introduction}
%-------------------------------------------------------------------------------

The algorithms used in ParU are discussed in a companion paper.
FIXME: cite our ACM TOMS submission, and include it the Doc folder.
FIXME NOW: cite our ACM TOMS submission, and include it the Doc folder.
This document gives detailed information on the installation and use of ParU.
ParU is a parallel sparse direct solver that uses OpenMP tasking for
parallelism. ParU calls UMFPACK for the symbolic analysis phase, after that,
Expand Down Expand Up @@ -274,7 +274,7 @@ \subsection{{\sf ParU\_Version}: version of the ParU package}

{\footnotesize
\begin{verbatim}
#define PARU_DATE "Apr XX, 2024" // FIXME
#define PARU_DATE "Apr XX, 2024" // FIXME NOW
#define PARU_VERSION_MAJOR 1
#define PARU_VERSION_MINOR 0
#define PARU_VERSION_UPDATE 0
Expand Down Expand Up @@ -485,7 +485,7 @@ \subsection{{\sf ParU\_Control}: parameters that control ParU}
\end{itemize}

Default values of Control parameters are defined below:
% FIXME: what should the default ordering be?
% FIXME NOW: what should the default ordering be?

{\footnotesize
\begin{verbatim}
Expand Down Expand Up @@ -1595,7 +1595,7 @@ \subsection{Compiling ParU for MATLAB}

{\bf Limitations:}
The MATLAB interface to ParU
has not yet been tested in Windows. % FIXME: test mexFunction on Windows
has not yet been tested in Windows. % FIXME NOW: test mexFunction on Windows
The built-in compiler used by the MATLAB \verb'mex' command on Windoes does not
support OpenMP, so only parallelism within the BLAS can be used on Windows.

Expand Down
6 changes: 3 additions & 3 deletions ParU/Source/ParU_Get.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ ParU_Info ParU_Get

case PARU_GET_LNZ:
if (!Num || Num->sym_m != n) return (PARU_INVALID) ;
(*result) = 0 ; // FIXME: get nnz(L)
(*result) = 0 ; // FIXME NOW: get nnz(L)
break ;

case PARU_GET_UNZ:
if (!Num || Num->sym_m != n) return (PARU_INVALID) ;
(*result) = 0 ; // FIXME: get nnz(U)
(*result) = 0 ; // FIXME NOW: get nnz(U)
break ;

case PARU_GET_P:
Expand Down Expand Up @@ -150,7 +150,7 @@ ParU_Info ParU_Get
switch (field)
{
case PARU_GET_FLOP_COUNT:
(*result) = 0 ; // FIXME: get flop count
(*result) = 0 ; // FIXME NOW: get flop count
break ;

case PARU_GET_RCOND_ESTIMATE:
Expand Down
6 changes: 3 additions & 3 deletions ParU/TODO.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FIXME test performance results again, for ACM TOMS paper
FIXME is Doc/Doxyfile needed?
FIXME NOW: test performance results again, for ACM TOMS paper
FIXME NOW: is Doc/Doxyfile needed?

FIXME: what should the default ordering be? What if it is invalid?
FIXME NOW: what should the default ordering be? What if it is invalid?
In v0.1, if the ordering parameter was out of bounds, it was set to AMD
(not the default). The default was METIS in the ParU.h definitions for the
Control struct. Should the default be METIS_GUARD? or AMD? METIS_GUARD is
Expand Down

0 comments on commit a77a225

Please sign in to comment.