Templatize the examples. #513

pratikvn · 2020-04-25T11:56:58Z

This PR adds template parameters to the declarations of the objects in the examples making it easier to change the precisions with the using statements in the beginning of the main function.

Only the minimal-cuda-solver is left as it is so that we demonstrate that we do have the defaults in place.

codecov · 2020-04-25T18:09:21Z

Codecov Report

Merging #513 into develop will decrease coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #513      +/-   ##
===========================================
- Coverage    88.42%   88.41%   -0.02%     
===========================================
  Files          269      269              
  Lines        16990    17008      +18     
===========================================
+ Hits         15024    15038      +14     
- Misses        1966     1970       +4

Impacted Files	Coverage Δ
omp/components/format_conversion.hpp	`40.00% <0.00%> (-60.00%)`	⬇️
include/ginkgo/core/matrix/ell.hpp	`68.75% <0.00%> (-31.25%)`	⬇️
include/ginkgo/core/base/polymorphic_object.hpp	`95.23% <0.00%> (-3.20%)`	⬇️
include/ginkgo/core/base/lin_op.hpp	`76.19% <0.00%> (+17.85%)`	⬆️

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 120963c...fcff165. Read the comment docs.

upsj

LGTM!

examples/custom-matrix-format/custom-matrix-format.cpp

examples/ilu-preconditioned-solver/ilu-preconditioned-solver.cpp

examples/poisson-solver/poisson-solver.cpp

Co-authored by: Tobias Ribizel<ribizel@kit.edu>

examples/poisson-solver/poisson-solver.cpp

Co-Authored-By: Tobias Ribizel <ribizel@kit.edu>

tcojean

LGTM in general, but some things are still not properly adaptated to the new format. I haven't finished looking over all of the examples yet, I will post an updated list later if there's anything left.

examples/custom-stopping-criterion/custom-stopping-criterion.cpp

examples/ilu-preconditioned-solver/ilu-preconditioned-solver.cpp

examples/nine-pt-stencil-solver/nine-pt-stencil-solver.cpp

examples/papi-logging/papi-logging.cpp

examples/nine-pt-stencil-solver/nine-pt-stencil-solver.cpp

examples/performance-debugging/performance-debugging.cpp

examples/twentyseven-pt-stencil-solver/twentyseven-pt-stencil-solver.cpp

Co-Authored by: Terry Cojean <>

thoasm

Part 1/2 (I need to send my review to comment on another review).
Please change the reduction_factor

examples/custom-matrix-format/stencil_kernel.hpp

examples/adaptiveprecision-blockjacobi/adaptiveprecision-blockjacobi.cpp

tcojean

I have two more comments, but I think that's the last of them.

examples/performance-debugging/performance-debugging.cpp

examples/twentyseven-pt-stencil-solver/twentyseven-pt-stencil-solver.cpp

thoasm

Part 2/2
just some nits.

examples/nine-pt-stencil-solver/nine-pt-stencil-solver.cpp

thoasm · 2020-04-27T16:23:27Z

examples/twentyseven-pt-stencil-solver/twentyseven-pt-stencil-solver.cpp

 {
-    int pos = 0;
+    IndexType pos = 0;
    size_t dp_2 = dp * dp;


nit: this variable is unused.

examples/twentyseven-pt-stencil-solver/twentyseven-pt-stencil-solver.cpp

examples/adaptiveprecision-blockjacobi/adaptiveprecision-blockjacobi.cpp

Co-Authored-By: Thomas Grützmacher <thomas.gruetzmacher@kit.edu>

pratikvn · 2020-04-29T13:05:18Z

This should be ready for review again.

Stall review

thoasm

LGTM!

tcojean

LGTM !

sonarqubecloud · 2020-05-09T14:15:41Z

Kudos, SonarCloud Quality Gate passed!

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

No Coverage information
No Duplication information

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. reg:example This is related to the examples. 1:ST:ready-for-review This PR is ready for review labels Apr 25, 2020

pratikvn self-assigned this Apr 25, 2020

Templatize the examples.

09a9f8c

pratikvn force-pushed the examples-fix branch from 45b3141 to 09a9f8c Compare April 25, 2020 11:58

pratikvn requested review from hartwiganzt, tcojean, fritzgoebel, thoasm, upsj and yhmtsai April 25, 2020 11:59

hartwiganzt approved these changes Apr 25, 2020

View reviewed changes

upsj approved these changes Apr 25, 2020

View reviewed changes

examples/custom-matrix-format/custom-matrix-format.cpp Outdated Show resolved Hide resolved

examples/ilu-preconditioned-solver/ilu-preconditioned-solver.cpp Outdated Show resolved Hide resolved

examples/poisson-solver/poisson-solver.cpp Outdated Show resolved Hide resolved

Review update.

65a2aae

Co-authored by: Tobias Ribizel<ribizel@kit.edu>

upsj reviewed Apr 27, 2020

View reviewed changes

examples/poisson-solver/poisson-solver.cpp Outdated Show resolved Hide resolved

pratikvn and others added 2 commits April 27, 2020 10:19

Review update

1685468

Co-Authored-By: Tobias Ribizel <ribizel@kit.edu>

Update adaptive-bj example.

664cc95

hartwiganzt approved these changes Apr 27, 2020

View reviewed changes

tcojean requested changes Apr 27, 2020

View reviewed changes

Review update.

e727324

Co-Authored by: Terry Cojean <>

thoasm previously requested changes Apr 27, 2020

View reviewed changes

examples/custom-matrix-format/stencil_kernel.hpp Outdated Show resolved Hide resolved

examples/adaptiveprecision-blockjacobi/adaptiveprecision-blockjacobi.cpp Outdated Show resolved Hide resolved

examples/adaptiveprecision-blockjacobi/adaptiveprecision-blockjacobi.cpp Show resolved Hide resolved

tcojean reviewed Apr 27, 2020

View reviewed changes

examples/performance-debugging/performance-debugging.cpp Show resolved Hide resolved

examples/twentyseven-pt-stencil-solver/twentyseven-pt-stencil-solver.cpp Show resolved Hide resolved

thoasm reviewed Apr 27, 2020

View reviewed changes

pratikvn and others added 4 commits April 27, 2020 22:14

Some types and typos

d42f3b0

Co-Authored-By: Thomas Grützmacher <thomas.gruetzmacher@kit.edu>

Add constness and fix typos.

1099e96

Co-Authored-By: Thomas Grützmacher <thomas.gruetzmacher@kit.edu>

Add std::complex support for examples.

5d1db23

Set double as default and print correct solution in perf-debug ex.

fcff165

thoasm approved these changes Apr 29, 2020

View reviewed changes

tcojean approved these changes Apr 29, 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 Apr 29, 2020

pratikvn merged commit 6ca781c into develop Apr 29, 2020

pratikvn deleted the examples-fix branch April 29, 2020 19:58

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

Templatize the examples. #513

Templatize the examples. #513

pratikvn commented Apr 25, 2020

codecov bot commented Apr 25, 2020 •

edited

Loading

upsj left a comment

tcojean left a comment

thoasm left a comment

tcojean left a comment

thoasm left a comment

thoasm Apr 27, 2020

pratikvn commented Apr 29, 2020

thoasm left a comment

tcojean left a comment

sonarqubecloud bot commented May 9, 2020

Templatize the examples. #513

Templatize the examples. #513

Conversation

pratikvn commented Apr 25, 2020

codecov bot commented Apr 25, 2020 • edited Loading

Codecov Report

upsj left a comment

Choose a reason for hiding this comment

tcojean left a comment

Choose a reason for hiding this comment

thoasm left a comment

Choose a reason for hiding this comment

tcojean left a comment

Choose a reason for hiding this comment

thoasm left a comment

Choose a reason for hiding this comment

thoasm Apr 27, 2020

Choose a reason for hiding this comment

pratikvn commented Apr 29, 2020

thoasm left a comment

Choose a reason for hiding this comment

tcojean left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented May 9, 2020

codecov bot commented Apr 25, 2020 •

edited

Loading