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_bsr

Out-of-place conversion of the source matrix to BSR format in dest matrix handle with specified block size and block layout.

Syntax

sparse_status_t mkl_sparse_convert_bsr ( const sparse_matrix_t source,
                                         const MKL_INT block_size,
                                         const sparse_layout_t block_layout,
                                         const sparse_operation_t operation,
                                               sparse_matrix_t *dest );

Include Files

mkl_spblas.h

Description

The mkl_sparse_convert_bsr routine fills the internals of the dest sparse matrix handle with a BSR matrix format representation of the matrix provided in source using the provided BSR block size and block layout.

NOTE:

When the source matrix is in COO format, the routine performs a sum reduction on duplicate elements.

Input Parameters

source

Handle containing internal data.

block_size

Size of the block in the output structure.

block_layout

Specifies layout of blocks:

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

operation

Specifies operation op() on input matrix, \(A\).

`operation`	Description
`SPARSE_OPERATION_NON_TRANSPOSE`	`\(op(A) = A\)`
`SPARSE_OPERATION_TRANSPOSE`	`\(op(A) = A^{T}\)`
`SPARSE_OPERATION_CONJUGATE_TRANSPOSE`	`\(op(A) = A^{H}\)`

Output Parameters

dest

Destination sparse matrix handle containing internal data in BSR format.

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