mkl_sparse

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 4/28/2026

Version

Public

mkl_sparse_copy

Out-of-place copy of the source matrix to the dest matrix handle.

Syntax

sparse_status_t mkl_sparse_copy ( const sparse_matrix_t source,
                                  const struct matrix_descr descr,
                                        sparse_matrix_t *dest );

Include Files

mkl_spblas.h

Description

The mkl_sparse_copy routine creates a copy of the source matrix handle to the dest matrix handle.

NOTE:

Currently, the mkl_sparse_copy routine does not support the descriptor argument and creates an exact (deep) copy of the input matrix.

Input Parameters

source

Handle containing internal data.

descr

Descriptor specifying sparse matrix properties.

sparse_matrix_type_t type

Specifies the type of a sparse matrix:

SPARSE_MATRIX_TYPE_GENERAL - The matrix is processed as is.
SPARSE_MATRIX_TYPE_SYMMETRIC - The matrix is symmetric (only the requested triangle is processed).
SPARSE_MATRIX_TYPE_HERMITIAN - The matrix is Hermitian (only the requested triangle is processed).
SPARSE_MATRIX_TYPE_TRIANGULAR - The matrix is triangular (only the requested triangle is processed).
SPARSE_MATRIX_TYPE_DIAGONAL - The matrix is diagonal (only diagonal elements are processed).
SPARSE_MATRIX_TYPE_BLOCK_TRIANGULAR - The matrix is block-triangular (only requested triangle is processed). Applies to BSR format only.
SPARSE_MATRIX_TYPE_BLOCK_DIAGONAL - The matrix is block-diagonal (only requested diagonal blocks are processed). Applies to BSR format only.

sparse_fill_mode_t mode

Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices:

SPARSE_FILL_MODE_LOWER - The lower triangular matrix part is processed.
SPARSE_FILL_MODE_UPPER - The upper triangular matrix part is processed.

sparse_diag_type_t diag

Specifies diagonal type for non-general matrices:

SPARSE_DIAG_NON_UNIT - Diagonal elements might not be equal to one.
SPARSE_DIAG_UNIT - Diagonal elements are equal to one.

NOTE:

This argument is currently unused and has no effect on the copy.

Output Parameters

dest

Destination sparse matrix handle containing internal data in same format as source matrix handle.

Return Values

The function returns a 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.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in