mkl::sparse::release_matrix_handle

Releases internal data and sets matrix_handle_t object to NULL.

Syntax

void mkl::sparse::release_matrix_handle ( matrix_handle_t handle, const cl::sycl::vector_class<cl::sycl::event> & dependencies ={});

Include Files

Description

Note

Refer to Exceptions for a detailed description of the exceptions thrown.

The mkl::sparse::release_matrix_handle routine releases (also waits for the dependencies to be finished in case of USM) any internal data that the matrix_handle_t object holds and sets it with default values, otherwise throws an exception.

Input Parameters

handle

Handle to object containing sparse matrix and other internal data. Created using one of the mkl::sparse::set_<sparse_matrix_type>_data routines.

dependencies

A vector of type cl::sycl::vector_class<cl::sycl::event> containing the list of events that handle depends on before resetting it to default values.