Skip to content

Commit 2c4545c

Browse files
authored
Merge pull request #46 from hifirworks/chiao/prepare-v0.2.0
Chiao/prepare v0.2.0
2 parents dfa267d + b1b79c4 commit 2c4545c

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ We follow the [Semantic Versioning](https://semver.org/) policy, which uses `MAJ
88
- `MINOR` version when you add functionality in a backwards compatible manner, and
99
- `PATCH` version when you make backwards compatible bug fixes.
1010

11-
## v0.2.0 (TBD) ##
11+
## [v0.2.0](https://github.com/hifirworks/hifir/releases/tag/v0.2.0) (TBD) ##
1212

1313
Changes from [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0) to v0.2.0:
1414

@@ -23,7 +23,7 @@ Changes from [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0) t
2323
- Added MatrixMarket file readers for the C library.
2424
- Added example code for `libhifir`.
2525

26-
[Full Changelog](https://github.com/hifirworks/hifir/compare/v0.1.0...HEAD)
26+
[Full Changelog](https://github.com/hifirworks/hifir/compare/v0.1.0...v0.2.0)
2727

2828
## [v0.1.0](https://github.com/hifirworks/hifir/releases/tag/v0.1.0) (2021-08-22) ##
2929

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Optionally, one can also use the C interface by building the runtime library `li
4343
### Third-Party Dependency: LAPACK ###
4444

4545
The only third-party dependency of HIFIR is LAPACK, which HIFIR uses for its dense-level factorization and solve. We recommend using [OpenBLAS](https://www.openblas.net/), [ATLAS](http://math-atlas.sourceforge.net/), or [Intel oneAPI Math Kernel Library](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onemkl.html) (formerly Intel MKL). Assuming you have system-administrator permussions, you can install OpenBLAS using the `apt` and `yum` command on Debian and RedHat-based Linux systems, such as
46+
4647
```console
4748
sudo apt install libopenblas-dev
4849
```
@@ -53,9 +54,9 @@ and
5354
sudo yum install libopenblas-devel
5455
```
5556

56-
If you prefer to use ATLAS, the corresponding libraries are `libatlas-dev` and `libatlas-devel` on Debian and RedHat-based systems, respectively. Note that if you have multiple versions of BLAS and LAPACK installed, you may need to use the `update-alternatives --config` or `alternatives --config` command to config your system for the proper versions of BLAS and LAPACK; see https://wiki.debian.org/DebianScience/LinearAlgebraLibraries and https://www.redhat.com/sysadmin/alternatives-command for more detail.
57+
If you prefer to use ATLAS, the corresponding libraries are `libatlas-dev` and `libatlas-devel` on Debian and RedHat-based systems, respectively. Note that if you have multiple versions of BLAS and LAPACK installed, you may need to use the `update-alternatives --config` or `alternatives --config` command to config your system for the proper versions of BLAS and LAPACK; see <https://wiki.debian.org/DebianScience/LinearAlgebraLibraries> and <https://www.redhat.com/sysadmin/alternatives-command> for more detail.
5758

58-
For Intel MKL, please refer to https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-apt-repo.html and https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-yum-repo.html for installation on Debian and RedHat-based systems, respectively.
59+
For Intel MKL, please refer to <https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-apt-repo.html> and <https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-yum-repo.html> for installation on Debian and RedHat-based systems, respectively.
5960

6061
For other platforms, please refer to the official documentation of [OpenBLAS](https://www.openblas.net), [ATLAS](http://math-atlas.sourceforge.net/faq.html#doc), [Intel MKL](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onemkl.html), or the vendor-provided LAPACK for your platform, respectively.
6162

@@ -88,7 +89,7 @@ If you plan to use HIFIR in solving singular and ill-conditioned systems, please
8889
```bibtex
8990
@Article{jiao2022approximate,
9091
author = {Xiangmin Jiao and Qiao Chen},
91-
journal = {SIAM J. Matrix Anal. Appl},
92+
journal = {SIAM J. Matrix Anal. Appl.},
9293
title = {Approximate generalized inverses with iterative refinement for
9394
$\epsilon$-accurate preconditioning of singular systems},
9495
year = {2022},
@@ -100,13 +101,13 @@ If you plan to use HIFIR in solving singular and ill-conditioned systems, please
100101
```
101102

102103
```bibtex
103-
@Article{chen2021hifir,
104+
@Article{chen2022hifir,
104105
author = {Chen, Qiao and Jiao, Xiangmin},
105106
title = {{HIFIR}: Hybrid incomplete factorization with iterative refinement
106107
for preconditioning ill-conditioned and singular systems},
107-
journal = {arXiv},
108-
year = {2021},
109-
note = {arXiv:2106.09877}
108+
journal = {ACM Trans. Math. Softw.},
109+
year = {2022},
110+
doi = {10.1145/3536165}
110111
}
111112
```
112113

docs/doxygen/contents/main.doc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ please cite the following papers.
5555
\verbatim
5656
@Article{jiao2022approximate,
5757
author = {Xiangmin Jiao and Qiao Chen},
58-
journal = {SIAM J. Matrix Anal. Appl},
58+
journal = {SIAM J. Matrix Anal. Appl.},
5959
title = {Approximate generalized inverses with iterative refinement for
6060
$\epsilon$-accurate preconditioning of singular systems},
6161
year = {2022},
@@ -67,13 +67,13 @@ please cite the following papers.
6767
\endverbatim
6868
6969
\verbatim
70-
@Article{chen2021hifir,
70+
@Article{chen2022hifir,
7171
author = {Chen, Qiao and Jiao, Xiangmin},
7272
title = {{HIFIR}: Hybrid incomplete factorization with iterative refinement
7373
for preconditioning ill-conditioned and singular systems},
74-
journal = {arXiv},
75-
year = {2021},
76-
note = {arXiv:2106.09877}
74+
journal = {ACM Trans. Math. Softw.},
75+
year = {2022},
76+
doi = {10.1145/3536165}
7777
}
7878
\endverbatim
7979

0 commit comments

Comments
 (0)