oneapi::mkl::sparse::optimize_gemv#
Performs internal optimizations for oneapi::mkl::sparse::gemv by analyzing the matrix structure.
Description#
Note
Refer to Error Handling for a detailed description of the possible exceptions thrown.
The oneapi::mkl::sparse::optimize_gemv
routine analyzes matrix structure and performs optimizations. Optimized
data is then stored in the matrix handle.
API#
Syntax#
Using USM and SYCL buffers:
namespace oneapi::mkl::sparse {
sycl::event optimize_gemv (
sycl::queue &queue,
oneapi::mkl::transpose opA,
oneapi::mkl::sparse::matrix_handle_t A,
const std::vector<sycl::event> &dependencies = {});
}
Include Files#
oneapi/mkl/spblas.hpp
Input Parameters#
- queue
Specifies the SYCL command queue which will be used for SYCL kernels execution.
- opA
Specifies operation
op()
on input matrix.oneapi::mkl::transpose::nontrans
Non-transpose,
op(A)
=A
.oneapi::mkl::transpose::trans
Transpose,
op(A)
=A
T.oneapi::mkl::transpose::conjtrans
Conjugate transpose,
op(A)
=A
H.- A
Handle to object containing sparse matrix and other internal data. Created using one of the
oneapi::mkl::sparse::set_<sparse_matrix_type>_data
routines.Note
The supported cases for
<sparse_matrix_type>
arecsr
andcoo
on both CPU and GPU devices.- dependencies
A vector of type
std::vector<sycl::event> &
containing the list of events that theoneapi::mkl::sparse::optimize_gemv
routine depends on.
Return Values#
sycl::event
SYCL event which can be waited upon or added as a dependency for the completion of the
optimize_gemv
routine.sycl::event ev_opt = sparse::optimize_gemv(queue, opA, A); // Allowed use in case of USM sycl::event ev_opt = sparse::optimize_gemv(queue, opA, A, {}); // Allowed use in case of USM sycl::event ev_opt = sparse::optimize_gemv(queue, opA, A, dependencies); // Allowed use in case of USM sparse::optimize_gemv(queue, opA, A); // OK -- Recommended use in case of sycl::buffer static_cast<void>(sparse::optimize_gemv(queue, opA, A)); // OK -- Recommended use in case of sycl::buffer - explicitly say we aren't using the event sparse::optimize_gemv(queue, opA, A, {}); // Not recommended in case of sycl::buffer, but supported; sparse::optimize_gemv(queue, opA, A, dependencies); // Not recommended in case of sycl::buffer, but supported; sycl::event ev_opt = sparse::optimize_gemv(queue, opA, A); // Allowed use in case of sycl::buffer, but most sycl::buffer oneMKL APIs do not have ability to pass in dependencies