Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/22/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_convert_bsr

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

Syntax

stat = mkl_sparse_convert_bsr (source, block_size, block_layout, operation, dest)

Include Files

  • mkl_spblas.f90

Description

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

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

Input Parameters

source

SPARSE_MATRIX_T.

Handle containing internal data.

block_size

C_INT.

Size of the block in the output structure.

block_layout

sparse_index_base_t.

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

C_INT.

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

SPARSE_MATRIX_T.

Handle containing internal data.

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.