oneapi::mkl::sparse::init_matmat_descr¶
Allocates and initializes a oneapi::mkl::sparse::matmat_descr_t
object to default values.
Description¶
The oneapi::mkl::sparse::init_matmat_descr
routine allocates and initializes the oneapi::mkl::sparse::matmat_descr_t
object with default
values, otherwise it throws an exception.
Note
Refer to Error Handling for a detailed description of the exceptions thrown.
A common usage model for the matmat
descriptor is the following
using namespace oneapi::mkl;
sparse::matmat_descr_t descr = nullptr;
sparse::init_matmat_descr(&descr);
// example descriptor for general
// C = A * B^T
sparse::matrix_view_descr viewA = sparse::matrix_view_descr::general;
sparse::matrix_view_descr viewB = sparse::matrix_view_descr::general;
sparse::matrix_view_descr viewC = sparse::matrix_view_descr::general;
transpose opA = transpose::nontrans;
transpose opB = transpose::trans;
sparse::set_matmat_data(descr, viewA, opA, viewB, opB, viewC);
// use descr in sparse::matmat() api
sparse::release_matmat_descr(&descr);
API¶
Syntax¶
namespace oneapi::mkl::sparse {
void init_matmat_descr ( oneapi::mkl::sparse::matmat_descr_t *p_descr );
}
Include Files¶
oneapi/mkl/spblas.hpp
Input Parameters¶
- p_descr
The address of an uninitialized (nullptr) matmat descriptor object to be initialized in this routine.
Output Parameters¶
- p_descr
On return, the address will be updated to point to a newly allocated and initialized
sparse::matmat_descr_t
object ready for use in matmat routines.