oneapi::mkl::sparse::release_matrix_handle

Releases internal data and sets oneapi::mkl::sparse::matrix_handle_t object to NULL.

Syntax

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

Include Files

  • mkl_spblas_sycl.hpp

Description

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

Note

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

Input Parameters

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 handle depends on before resetting it to default values.