Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/31/2023
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_convert_bsr

Converts internal matrix representation to BSR format or changes BSR block size.

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

Themkl_sparse_convert_bsr routine converts internal matrix representation to BSR format or changes BSR block size.

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_ROW_MAJOR

Storage of elements of blocks uses row major layout.

SPARSE_LAYOUT_COLUMN_MAJOR

Storage of elements of blocks uses column major layout.

operation

Specifies operation op() on input matrix.

SPARSE_OPERATION_NON_TRANSPOSE

Non-transpose, op(A) = A.

SPARSE_OPERATION_TRANSPOSE

Transpose, op(A) = AT.

SPARSE_OPERATION_CONJUGATE_TRANSPOSE

Conjugate transpose, op(A) = AH.

Output Parameters

dest

Handle containing internal data.

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.