Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add virtual method apply_uses_initial_guess to LinOp #531

Merged
merged 9 commits into from
May 15, 2020

Conversation

fritzgoebel
Copy link
Collaborator

apply_uses_initial_guess returns true if the linear operator uses the data stored in x as an initial guess and false otherwise.

This enables e.g. IR to distinguish between inner solvers that use an initial guess (all iterative solvers) and ones that don't (direct triangular solves and e.g. block-Jacobi preconditioner).

Copy link
Member

@upsj upsj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

include/ginkgo/core/solver/bicg.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/bicgstab.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/cg.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/cgs.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/fcg.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/gmres.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/solver/ir.hpp Outdated Show resolved Hide resolved
core/solver/ir.cpp Outdated Show resolved Hide resolved
@fritzgoebel fritzgoebel force-pushed the specify_need_for_initial_guess branch from 02deab5 to 6effeb3 Compare May 11, 2020 15:47
@fritzgoebel fritzgoebel added the 1:ST:ready-for-review This PR is ready for review label May 11, 2020
Copy link
Member

@yhmtsai yhmtsai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@pratikvn pratikvn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@codecov
Copy link

codecov bot commented May 11, 2020

Codecov Report

Merging #531 into develop will increase coverage by 0.05%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #531      +/-   ##
===========================================
+ Coverage    88.42%   88.47%   +0.05%     
===========================================
  Files          276      276              
  Lines        17419    17454      +35     
===========================================
+ Hits         15403    15443      +40     
+ Misses        2016     2011       -5     
Impacted Files Coverage Δ
core/solver/ir.cpp 95.65% <100.00%> (+0.53%) ⬆️
core/test/base/lin_op.cpp 92.40% <100.00%> (+0.09%) ⬆️
core/test/solver/bicg.cpp 100.00% <100.00%> (ø)
core/test/solver/bicgstab.cpp 100.00% <100.00%> (ø)
core/test/solver/cg.cpp 100.00% <100.00%> (ø)
core/test/solver/cgs.cpp 100.00% <100.00%> (ø)
core/test/solver/fcg.cpp 100.00% <100.00%> (ø)
core/test/solver/gmres.cpp 98.93% <100.00%> (+0.01%) ⬆️
core/test/solver/ir.cpp 100.00% <100.00%> (ø)
include/ginkgo/core/base/lin_op.hpp 58.82% <100.00%> (-9.04%) ⬇️
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 500d4a5...526802a. Read the comment docs.

@pratikvn
Copy link
Member

pratikvn commented May 11, 2020

Ah, I just realized, you are missing the tests. You can add these in the core/test/base/lin_op.cpp file. And because you override them in the solvers, you would need to add the tests for each of the solvers as well.

Copy link
Member

@tcojean tcojean left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM although missing tests as Pratik said.

@pratikvn pratikvn added mod:core This is related to the core module. is:enhancement An improvement of an existing feature. type:solver This is related to the solvers labels May 12, 2020
@pratikvn
Copy link
Member

It still seems that the coverage reduces by a bit. Especially for the IR. Do you have an idea, why ?

@upsj
Copy link
Member

upsj commented May 13, 2020

Adding a reference test with IR and an iterative inner solver should fix that, right?

@fritzgoebel
Copy link
Collaborator Author

Yes, I guess both paths in IR should be tested. I'll add something.

@tcojean tcojean added this to the Ginkgo 1.2.0 milestone May 14, 2020
@fritzgoebel fritzgoebel force-pushed the specify_need_for_initial_guess branch from 537e3a4 to be24bc3 Compare May 14, 2020 08:40
cuda/test/solver/ir_kernels.cpp Outdated Show resolved Hide resolved
hip/test/solver/ir_kernels.cpp Outdated Show resolved Hide resolved
omp/test/solver/ir_kernels.cpp Outdated Show resolved Hide resolved
Copy link
Member

@thoasm thoasm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just some missing doxygen comments.

include/ginkgo/core/base/lin_op.hpp Show resolved Hide resolved
include/ginkgo/core/solver/bicg.hpp Show resolved Hide resolved
include/ginkgo/core/solver/bicgstab.hpp Show resolved Hide resolved
include/ginkgo/core/solver/cg.hpp Show resolved Hide resolved
include/ginkgo/core/solver/cgs.hpp Show resolved Hide resolved
include/ginkgo/core/solver/fcg.hpp Show resolved Hide resolved
include/ginkgo/core/solver/gmres.hpp Show resolved Hide resolved
include/ginkgo/core/solver/ir.hpp Show resolved Hide resolved
Co-authored-by: Thomas Grützmacher <[email protected]>
@fritzgoebel fritzgoebel merged commit 4cfc6a1 into develop May 15, 2020
@fritzgoebel fritzgoebel deleted the specify_need_for_initial_guess branch May 15, 2020 07:12
@upsj upsj added 1:ST:ready-to-merge This PR is ready to merge. and removed 1:ST:ready-for-review This PR is ready for review labels May 16, 2020
@sonarcloud
Copy link

sonarcloud bot commented May 20, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tcojean tcojean mentioned this pull request Jun 23, 2020
tcojean added a commit that referenced this pull request Jul 7, 2020
The Ginkgo team is proud to announce the new minor release of Ginkgo version
1.2.0. This release brings full HIP support to Ginkgo, new preconditioners
(ParILUT, ISAI), conversion between double and float for all LinOps, and many
more features and fixes.

Supported systems and requirements:
+ For all platforms, cmake 3.9+
+ Linux and MacOS
  + gcc: 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + clang: 3.9+
  + Intel compiler: 2017+
  + Apple LLVM: 8.0+
  + CUDA module: CUDA 9.0+
  + HIP module: ROCm 2.8+
+ Windows
  + MinGW and CygWin: gcc 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + Microsoft Visual Studio: VS 2017 15.7+
  + CUDA module: CUDA 9.0+, Microsoft Visual Studio
  + OpenMP module: MinGW or CygWin.


The current known issues can be found in the [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues).


# Additions
Here are the main additions to the Ginkgo library. Other thematic additions are listed below.
+ Add full HIP support to Ginkgo [#344](#344), [#357](#357), [#384](#384), [#373](#373), [#391](#391), [#396](#396), [#395](#395), [#393](#393), [#404](#404), [#439](#439), [#443](#443), [#567](#567)
+ Add a new ISAI preconditioner [#489](#489), [#502](#502), [#512](#512), [#508](#508), [#520](#520)
+ Add support for ParILUT and ParICT factorization with ILU preconditioners [#400](#400)
+ Add a new BiCG solver [#438](#438)
+ Add a new permutation matrix format [#352](#352), [#469](#469)
+ Add CSR SpGEMM support [#386](#386), [#398](#398), [#418](#418), [#457](#457)
+ Add CSR SpGEAM support [#556](#556)
+ Make all solvers and preconditioners transposable [#535](#535)
+ Add CsrBuilder and CooBuilder for intrusive access to matrix arrays [#437](#437)
+ Add a standard-compliant allocator based on the Executors [#504](#504)
+ Support conversions for all LinOp between double and float [#521](#521)
+ Add a new boolean to the CUDA and HIP executors to control DeviceReset (default off) [#557](#557)
+ Add a relaxation factor to IR to represent Richardson Relaxation [#574](#574)
+ Add two new stopping criteria, for relative (to `norm(b)`) and absolute residual norm [#577](#577)

### Example additions
+ Templatize all examples to simplify changing the precision [#513](#513)
+ Add a new adaptive precision block-Jacobi example [#507](#507)
+ Add a new IR example [#522](#522)
+ Add a new Mixed Precision Iterative Refinement example [#525](#525)
+ Add a new example on iterative trisolves in ILU preconditioning [#526](#526), [#536](#536), [#550](#550)

### Compilation and library changes
+ Auto-detect compilation settings based on environment [#435](#435), [#537](#537)
+ Add SONAME to shared libraries [#524](#524)
+ Add clang-cuda support [#543](#543)

### Other additions
+ Add sorting, searching and merging kernels for GPUs [#403](#403), [#428](#428), [#417](#417), [#455](#455)
+ Add `gko::as` support for smart pointers [#493](#493)
+ Add setters and getters for criterion factories [#527](#527)
+ Add a new method to check whether a solver uses `x` as an initial guess [#531](#531)
+ Add contribution guidelines [#549](#549)

# Fixes
### Algorithms
+ Improve the classical CSR strategy's performance [#401](#401)
+ Improve the CSR automatical strategy [#407](#407), [#559](#559)
+ Memory, speed improvements to the ELL kernel [#411](#411)
+ Multiple improvements and fixes to ParILU [#419](#419), [#427](#427), [#429](#429), [#456](#456), [#544](#544)
+ Fix multiple issues with GMRES [#481](#481), [#523](#523), [#575](#575)
+ Optimize OpenMP matrix conversions [#505](#505)
+ Ensure the linearity of the ILU preconditioner [#506](#506)
+ Fix IR's use of the advanced apply [#522](#522)
+ Fix empty matrices conversions and add tests [#560](#560)

### Other core functionalities
+ Fix complex number support in our math header [#410](#410)
+ Fix CUDA compatibility of the main ginkgo header [#450](#450)
+ Fix isfinite issues [#465](#465)
+ Fix the Array::view memory leak and the array/view copy/move [#485](#485)
+ Fix typos preventing use of some interface functions [#496](#496)
+ Fix the `gko::dim` to abide to the C++ standard [#498](#498)
+ Simplify the executor copy interface [#516](#516)
+ Optimize intermediate storage for Composition [#540](#540)
+ Provide an initial guess for relevant Compositions [#561](#561)
+ Better management of nullptr as criterion [#562](#562)
+ Fix the norm calculations for complex support [#564](#564)

### CUDA and HIP specific
+ Use the return value of the atomic operations in our wrappers [#405](#405)
+ Improve the portability of warp lane masks [#422](#422)
+ Extract thread ID computation into a separate function [#464](#464)
+ Reorder kernel parameters for consistency [#474](#474)
+ Fix the use of `pragma unroll` in HIP [#492](#492)

### Other
+ Fix the Ginkgo CMake installation files [#414](#414), [#553](#553)
+ Fix the Windows compilation [#415](#415)
+ Always use demangled types in error messages [#434](#434), [#486](#486)
+ Add CUDA header dependency to appropriate tests [#452](#452)
+ Fix several sonarqube or compilation warnings [#453](#453), [#463](#463), [#532](#532), [#569](#569)
+ Add shuffle tests [#460](#460)
+ Fix MSVC C2398 error [#490](#490)
+ Fix missing interface tests in test install [#558](#558)

# Tools and ecosystem
### Benchmarks
+ Add better norm support in the benchmarks [#377](#377)
+ Add CUDA 10.1 generic SpMV support in benchmarks [#468](#468), [#473](#473)
+ Add sparse library ILU in benchmarks [#487](#487)
+ Add overhead benchmarking capacities [#501](#501)
+ Allow benchmarking from a matrix list file [#503](#503)
+ Fix benchmarking issue with JSON and non-finite numbers [#514](#514)
+ Fix benchmark logger crashers with OpenMP [#565](#565)

### CI related
+ Improvements to the CI setup with HIP compilation [#421](#421), [#466](#466)
+ Add MacOSX CI support [#470](#470), [#488](#488)
+ Add Windows CI support [#471](#471), [#488](#488), [#510](#510), [#566](#566)
+ Use sanitizers instead of valgrind [#476](#476)
+ Add automatic container generation and update facilities [#499](#499)
+ Fix the CI parallelism settings [#517](#517), [#538](#538), [#539](#539)
+ Make the codecov patch check informational [#519](#519)
+ Add support for LLVM sanitizers with improved thread sanitizer support [#578](#578)

### Test suite
+ Add an assertion for sparsity pattern equality [#416](#416)
+ Add core and reference multiprecision tests support [#448](#448)
+ Speed up GPU tests by avoiding device reset [#467](#467)
+ Change test matrix location string [#494](#494)

### Other
+ Add Ginkgo badges from our tools [#413](#413)
+ Update the `create_new_algorithm.sh` script [#420](#420)
+ Bump copyright and improve license management [#436](#436), [#433](#433)
+ Set clang-format minimum requirement [#441](#441), [#484](#484)
+ Update git-cmake-format [#446](#446), [#484](#484)
+ Disable the development tools by default [#442](#442)
+ Add a script for automatic header formatting [#447](#447)
+ Add GDB pretty printer for `gko::Array` [#509](#509)
+ Improve compilation speed [#533](#533)
+ Add editorconfig support [#546](#546)
+ Add a compile-time check for header self-sufficiency [#552](#552)


# Related PR: #583
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1:ST:ready-to-merge This PR is ready to merge. is:enhancement An improvement of an existing feature. mod:core This is related to the core module. type:solver This is related to the solvers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants