Blas1: docs update for PR #1803 #1805
Conversation
|
Making this PR WIP so that it does not trigger any testing as it only contains changes to documentation (both inline and in rst files). |
blas/src/KokkosBlas1_abs.hpp
Outdated
|
|
||
| /// \brief R(i,j) = abs(X(i,j)) | ||
| /// | ||
| /// Replace each entry in R with the absolute value (magnitude) of the |
There was a problem hiding this comment.
| /// Replace each entry in R with the absolute value (magnitude) of the | |
| /// Non-blocking function to replace each entry in R with the absolute value (magnitude) of the |
| @@ -28,18 +28,34 @@ namespace KokkosBlas { | |||
| /// Replace each entry in R with the absolute value (magnitude) of the | |||
| /// corresponding entry in X. | |||
| /// | |||
| /// \tparam execution_space a Kokkos execution space to run the kernels on. | |||
There was a problem hiding this comment.
| /// \tparam execution_space a Kokkos execution space to run the kernels on. | |
| /// \tparam execution_space a Kokkos execution space to run the kernels on (default: RMV::execution_space) |
There was a problem hiding this comment.
Actually, we should document this in the overload without a space parameter.
|
@e10harvey thanks for approving this although it would be best if you approved the original PR as it needs to merge before this one... |
@lucbv: Both are approved now. Merging this PR should mark #1803 as merged since these commits are a superset of the commits in 1803. |
|
Actually I believe I have fixed an issue or two with the TPLs yesterday that is not in this branch so this branch needs to be at least rebased. |
This documents the addition of the execution_space template parameter and the associated space parameter to allow execution of the BLAS kernels in streams/queues when on device.
lucbv
force-pushed
the
blas1_on_stream_docs
branch
from
3d2639e to
03d6787
Compare
Okay, note that this PR went from 11 commits to 3 commits after #1803 merged and that these 3 commits only touch c++ comments and .rst files which were tested via github-DOCS in this PR. |
|
Yes, I agree but before I rebased they had code changes and if anything was slightly out of sync between this PR and #1803 we would be introducing a bug. |
updating documentation for changes in PR #1803, this PR will be rebased once #1803 is merged.
It mostly includes additional overloads of our BLAS1 functions to accept an execution space instance.
Additional documentation improvement have been made as well.