mkl_sparse_?_convert

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 4/28/2026

Version

Public

mkl_sparse_?_convert_dense

Conversion of the source sparse matrix to dense format in adns array.

Syntax

sparse_status_t mkl_sparse_s_convert_dense ( const sparse_matrix_t source,
                                             const struct matrix_descr descr,
                                             const sparse_layout_t dense_layout,
                                             const MKL_INT lda,
                                                   float *adns );

sparse_status_t mkl_sparse_d_convert_dense ( const sparse_matrix_t source,
                                             const struct matrix_descr descr,
                                             const sparse_layout_t dense_layout,
                                             const MKL_INT lda,
                                                   double *adns );

sparse_status_t mkl_sparse_c_convert_dense ( const sparse_matrix_t source,
                                             const struct matrix_descr descr,
                                             const sparse_layout_t dense_layout,
                                             const MKL_INT lda,
                                                   MKL_Complex8 *adns );

sparse_status_t mkl_sparse_z_convert_dense ( const sparse_matrix_t source,
                                             const struct matrix_descr descr,
                                             const sparse_layout_t dense_layout,
                                             const MKL_INT lda,
                                                   MKL_Complex16 *adns );

Include Files

mkl_spblas.h

Description

The mkl_sparse_?_convert_dense routine converts a sparse matrix handle to a dense matrix representation and stores the result in the user-provided dense array.

NOTE:

Currently, only SPARSE_MATRIX_TYPE_GENERAL is supported for the descr matrix type. The mode and diag fields of the descriptor are ignored.

See also mkl_sparse_?_dense2csr , mkl_sparse_?_dense2csc , mkl_sparse_?_dense2coo , and mkl_sparse_?_dense2bsr for the reverse operations (dense to sparse).

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.

dense_layout

Describes the storage scheme for the dense matrix:

`SPARSE_LAYOUT_COLUMN_MAJOR`	Storage of elements uses column major layout.
`SPARSE_LAYOUT_ROW_MAJOR`	Storage of elements uses row major layout.

lda

Leading dimension of the dense matrix. For column-major layout, must be at least rows. For row-major layout, must be at least cols.

Output Parameters

adns

Array filled with elements of the dense matrix. Must be pre-allocated with size at least lda * cols for column-major layout or lda * rows for row-major layout.

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