Add setters and getters for some solver parameters #527

pratikvn · 2020-05-07T09:41:15Z

This PR adds a macro to set solver parameters after the solver has been generated. This allows for changing the max iter count, residual norm goal or other parameters for successive calls to solver applies without generating the solver again.
It is now updated to add the setters and getter functions instead. It was decided that the macro would cause more confusion than acceptable.

Additionally, it also adds typed tests for the Bicg solver which were missing.

The generate of the stopping criterion is called within the apply of the solvers. So when set after generate, it should use the new stopping criteria. This holds for any of the other class member variables which have setters and getters as well.

codecov · 2020-05-07T22:11:11Z

Codecov Report

Merging #527 into develop will increase coverage by 0.53%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #527      +/-   ##
===========================================
+ Coverage    88.46%   89.00%   +0.53%     
===========================================
  Files          276      276              
  Lines        17454    17574     +120     
===========================================
+ Hits         15441    15641     +200     
+ Misses        2013     1933      -80

Impacted Files	Coverage Δ
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	`99.13% <100.00%> (+0.20%)`	⬆️
core/test/solver/ir.cpp	`100.00% <100.00%> (ø)`
include/ginkgo/core/solver/bicg.hpp	`100.00% <100.00%> (ø)`
include/ginkgo/core/solver/bicgstab.hpp	`100.00% <100.00%> (ø)`
include/ginkgo/core/solver/cg.hpp	`100.00% <100.00%> (ø)`
... and 17 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 fd146da...48c590d. Read the comment docs.

reference/test/solver/bicg_kernels.cpp

include/ginkgo/core/base/lin_op.hpp

include/ginkgo/core/solver/bicg.hpp

tcojean

LGTM. Some comments on how this can be used in bad ways would be nice, though.

tcojean · 2020-05-14T06:49:25Z

reference/test/solver/bicg_kernels.cpp


 solver->apply(alpha.get(), b.get(), beta.get(), x.get());

- GKO_ASSERT_MTX_NEAR(x, l({{1.5, 1.0}, {5.0, 0.0}, {2.0, -1.0}}), 1e-14);
+ GKO_ASSERT_MTX_NEAR(x, l({{1.5, 1.0}, {5.0, 0.0}, {2.0, -1.0}}),
+ r<value_type>::value * 1e1);


I guess this fails in single if you don't have 1e1?

Yes, I think so.

include/ginkgo/core/base/lin_op.hpp

core/test/solver/gmres.cpp

tcojean

Scrap that.

Stale

yhmtsai · 2020-05-18T18:32:25Z

Is using a class to contain these functions (and maybe get_system_matrix) suitable?

pratikvn · 2020-05-19T06:55:09Z

@yhmtsai , Yes, we could do that. That would mean that the member variables would go into that new class and not be in the solver classes, which I am not a big fan of. Moreover, to me, setters and getters should be local to the class.

yhmtsai

I see, LGTM

+ For the stopping criteria. + For GMRES, for the krylov_dim as well. + Add tests.

@tcojean

Co-Authored-By: @tcojean

sonarcloud · 2020-05-20T21:49:35Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
19.5% Duplication

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

pratikvn added 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 1:ST:WIP This PR is a work in progress. Not ready for review. labels May 7, 2020

pratikvn self-assigned this May 7, 2020

pratikvn added 1:ST:ready-for-review This PR is ready for review and removed 1:ST:WIP This PR is a work in progress. Not ready for review. labels May 7, 2020

pratikvn requested review from thoasm, tcojean, yhmtsai, fritzgoebel, hartwiganzt and upsj May 7, 2020 11:38

pratikvn added 1:ST:WIP This PR is a work in progress. Not ready for review. and removed 1:ST:ready-for-review This PR is ready for review labels May 8, 2020

pratikvn force-pushed the reset_params branch from 6b45684 to 060c421 Compare May 8, 2020 12:26

upsj reviewed May 8, 2020

View reviewed changes

reference/test/solver/bicg_kernels.cpp Show resolved Hide resolved

include/ginkgo/core/base/lin_op.hpp Outdated Show resolved Hide resolved

yhmtsai previously requested changes May 12, 2020

View reviewed changes

include/ginkgo/core/base/lin_op.hpp Outdated Show resolved Hide resolved

include/ginkgo/core/solver/bicg.hpp Outdated Show resolved Hide resolved

pratikvn added 1:ST:ready-for-review This PR is ready for review and removed 1:ST:WIP This PR is a work in progress. Not ready for review. labels May 12, 2020

tcojean approved these changes May 14, 2020

View reviewed changes

tcojean reviewed May 14, 2020

View reviewed changes

core/test/solver/gmres.cpp Show resolved Hide resolved

tcojean requested changes May 14, 2020

View reviewed changes

tcojean approved these changes May 14, 2020

View reviewed changes

tcojean added this to the Ginkgo 1.2.0 milestone May 14, 2020

pratikvn force-pushed the reset_params branch 2 times, most recently from 4c594ca to fad22d4 Compare May 15, 2020 07:43

pratikvn requested a review from yhmtsai May 15, 2020 09:06

yhmtsai approved these changes May 19, 2020

View reviewed changes

tcojean 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 19, 2020

pratikvn force-pushed the reset_params branch from fad22d4 to 4c42c38 Compare May 19, 2020 18:15

pratikvn added 7 commits May 20, 2020 13:06

Add setters and getters for class parameters.

c8f11ff

Add setters to all solvers.

2ba2fb8

+ For the stopping criteria. + For GMRES, for the krylov_dim as well. + Add tests.

Add typed tests and setter tests for bicg.

7c34a82

Add Bicg typed tests for reference kernels.

f14ecfd

Add some documentation on the macro.

cb38ded

Review update. Clarify doc for macro.

36378ce

Co-Authored-By: @tcojean

Use setters and getters as functions instead of a macro.

48c590d

upsj approved these changes May 20, 2020

View reviewed changes

pratikvn force-pushed the reset_params branch from 4c42c38 to 48c590d Compare May 20, 2020 11:06

pratikvn merged commit 7034730 into develop May 20, 2020

pratikvn deleted the reset_params branch May 20, 2020 22:19

tcojean mentioned this pull request Jun 23, 2020

Release/1.2.0 #576

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add setters and getters for some solver parameters #527

Add setters and getters for some solver parameters #527

pratikvn commented May 7, 2020 •

edited

Loading

codecov bot commented May 7, 2020 •

edited

Loading

tcojean left a comment

tcojean May 14, 2020

pratikvn May 14, 2020

tcojean left a comment •

edited

Loading

yhmtsai commented May 18, 2020

pratikvn commented May 19, 2020

yhmtsai left a comment

sonarcloud bot commented May 20, 2020

Add setters and getters for some solver parameters #527

Add setters and getters for some solver parameters #527

Conversation

pratikvn commented May 7, 2020 • edited Loading

codecov bot commented May 7, 2020 • edited Loading

Codecov Report

tcojean left a comment

Choose a reason for hiding this comment

tcojean May 14, 2020

Choose a reason for hiding this comment

pratikvn May 14, 2020

Choose a reason for hiding this comment

tcojean left a comment • edited Loading

Choose a reason for hiding this comment

yhmtsai commented May 18, 2020

pratikvn commented May 19, 2020

yhmtsai left a comment

Choose a reason for hiding this comment

sonarcloud bot commented May 20, 2020

pratikvn commented May 7, 2020 •

edited

Loading

codecov bot commented May 7, 2020 •

edited

Loading

tcojean left a comment •

edited

Loading