oneapi::mkl::sparse::release_matrix

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 12/16/2022

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-5610B56D-8166-4FE7-BF8F-BC90BA2B0D61

View Details

oneapi::mkl::sparse::release_matrix_handle

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

Description
API

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 Error Handling for a detailed description of the possible exceptions thrown.

API

Syntax

namespace oneapi::mkl::sparse {

    void release_matrix_handle (
        sycl::queue & queue,
        oneapi::mkl::sparse::matrix_handle_t *handle,
        const std::vector<sycl::event> &dependencies = {});

    // deprecated in 2023.0
    void release_matrix_handle (
        oneapi::mkl::sparse::matrix_handle_t *handle,
        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.
handle: Handle to object containing sparse matrix and other internal data. Initialized with oneapi::mkl::sparse::init_matrix_handle routine and filled with user data using one of the oneapi::mkl::sparse::set_<sparse_matrix_type>_data routines. The oneapi::mkl::sparse::optimize_xyz routines may have also created additional internally allocated data which would be released in this call.

NOTE:
Currently, the only supported case for <sparse_matrix_type> is csr.
dependencies: A vector of type std::vector<sycl::event> & containing the list of events that handle depends on before executing the release of the matrix handle.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

oneapi::mkl::sparse::release_matrix_handle

Description

API