oneapi::mkl::sparse::optimize_gemv¶
Performs internal optimizations for oneapi::mkl::sparse::gemv by analyzing the matrix structure.
Syntax
Note
Currently, complex types are not supported.
Using SYCL buffers:
void oneapi::mkl::sparse::optimize_gemv (cl::sycl::queue & queue, oneapi::mkl::transpose transpose_flag, oneapi::mkl::sparse::matrix_handle_t handle)
Using USM pointers:
Note
Currently, the USM API might be a blocking call.
cl::sycl::event oneapi::mkl::sparse::optimize_gemv (
cl::sycl::queue & queue,
oneapi::mkl::transpose transpose_flag, oneapi::mkl::sparse::matrix_handle_t handle,
const cl::sycl::vector_class<cl::sycl::event> &dependencies)
Include Files
oneapi/mkl/spblas.hpp
Description
Note
Refer to Exceptions for a detailed description of the exceptions thrown. The oneapi::mkl::sparse::optimize_gemv
routine analyzes matrix structure and performs optimizations. Optimized data is then stored in the handle.
Input Parameters
- queue
Specifies the SYCL command queue which will be used for SYCL kernels execution.
- transpose_flag
Specifies operation
op()
on input matrix.
oneapi::mkl::transpose::nontrans |
Non-transpose, |
---|---|
oneapi::mkl::transpose::trans |
Transpose, |
oneapi::mkl::transpose::conjtrans |
Conjugate transpose, |
Note
Currently, the only supported case for operation is
oneapi::mkl::transpose::nontrans
.
- handle
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
Currently, the only supported case for <sparse_matrix_type> is csr.
- dependencies
A vector of type
cl::sycl::vector_class<cl::sycl::event>
containing the list of events that theoneapi::mkl::sparse::optimize_gemv
routine depends on.
Return Values (USM Only)
cl::sycl::event
SYCL event which can be waited upon or added as a dependency for the completion of the optimize_gemv routine.