Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

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

Document Table of Contents

mkl_sparse_destroy

Frees memory allocated for matrix handle.

Syntax

stat = mkl_sparse_destroy (A)

Include Files

  • mkl_spblas.f90

Description

The mkl_sparse_destroy routine frees memory allocated for matrix handle.

NOTE:

You must free memory allocated for matrices after completing use of them. The mkl_sparse_destroy routine provides a utility to do so.

Input Parameters

A

SPARSE_MATRIX_T.

Handle containing internal data.

Output Parameters

stat

INTEGER

Value indicating whether the operation was successful or not, and why:

SPARSE_STATUS_SUCCESS

The operation was successful.

SPARSE_STATUS_NOT_INITIALIZED

The routine encountered an empty handle or matrix array.

SPARSE_STATUS_ALLOC_FAILED

Internal memory allocation failed.

SPARSE_STATUS_INVALID_VALUE

The input parameters contain an invalid value.

SPARSE_STATUS_EXECUTION_FAILED

Execution failed.

SPARSE_STATUS_INTERNAL_ERROR

An error in algorithm implementation occurred.

SPARSE_STATUS_NOT_SUPPORTED

The requested operation is not supported.