Developer Reference for Intel® oneAPI Math Kernel Library for Fortran
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
stat = mkl_sparse_convert_bsr ( source, block_size, block_layout, operation, dest )
Include Files
mkl_spblas.f90
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.
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_layout_t .
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
C_INT .
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
SPARSE_MATRIX_T.
Destination sparse matrix handle containing internal data in BSR format.
stat
INTEGER
Value indicating whether the operation was successful, and if not, 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. |
Return Values
See Output Parameter, stat.