[oneMKL][spblas] update the spec for several spblas routines #491
Conversation
| void release_matrix_handle (oneapi::mkl::sparse::matrix_handle_t handle, | ||
| const std::vector<sycl::event> &dependencies = {}); | ||
| sycl::event release_matrix_handle (sycl::queue &queue, | ||
| oneapi::mkl::sparse::matrix_handle_t *handle, |
There was a problem hiding this comment.
lets name this p_handle instead of just handle :)
There was a problem hiding this comment.
might be good to do in initializematrixhandle.rst as well
…ix_handle routines.
|
|
||
| .. container:: section | ||
|
|
||
| .. rubric:: Input parameter | ||
|
|
||
| p_handle | ||
| The address of the sparse::matrix_handle_t ``p_handle`` object to be initialized. | ||
| This initialization routine must only be called on an uninitialized matrix_handle_t object. | ||
|
|
||
|
|
||
| .. container:: section | ||
|
|
||
| .. rubric:: Output parameters | ||
|
|
||
| p_handle | ||
| On return, the address is updated to point to a newly allocated and initialized matrix_handle_t object | ||
| that can be filled and used to perform sparse BLAS operations. |
There was a problem hiding this comment.
I think it would be better to have Input parameter and Output parameters sections as well in init_matrix_handle routine, so I added them as well.
There was a problem hiding this comment.
awesome! :) I think it did a similar thing once upon a time to our oneMKL documentation as well
There was a problem hiding this comment.
Section name is just changed as Input parameters. :)
| @@ -101,7 +28,7 @@ optimize_trmv (USM version) | |||
| oneapi::mkl::transpose transpose_val, | |||
| oneapi::mkl::diag diag_val, | |||
| oneapi::mkl::sparse::matrix_handle_t handle, | |||
| std::vector<sycl::event> &dependencies); | |||
| std::vector<sycl::event> &dependencies = {}); | |||
There was a problem hiding this comment.
I think this might need a const out front as well. right ?
There was a problem hiding this comment.
so it is a const reference
There was a problem hiding this comment.
Oh, right. I just made it with default value. I'll check and update as necessary.
There was a problem hiding this comment.
added const keyword for the dependencies list in those optimize_xyz routines.
…dation#491) * update spec for oneapi::mkl::sparse::release_matrix_handle() routine. * update spec for oneapi::mkl::sparse::set_csr_data() routine. * fix minor typo in the spec of the oneapi::mkl::sparse::gemm routine. * fix minor typo in the spec of the oneapi::mkl::sparse::gemv routine. * update spec for oneapi::mkl::sparse::optimize_gemv() routine. * update spec for oneapi::mkl::sparse::optimize_trmv() routine. * update spec for oneapi::mkl::sparse::optimize_trsv() routine. * rename 'handle' as 'p_handle' for init_matrix_handle and release_matrix_handle routines. * add missing 'const' keyword for dependencies list.
Goal:
As
oneapi::mkl::sparsedomain has been evolving, we find out that we need to update the oneapi spec for some routines in oneMKL/spblas domain.Details:
In this PR, I've updated several things:
constkeyword incorrectly to the output parameter.set_csr_dataandrelease_matrix_handleroutines.optimize_{gemv, trmv, trsv} routines, combined the separate APIs forsycl::bufferandUSM` containers into one common API.