Developer Reference

  • 2020.2
  • 07/15/2020
  • Public Content
Contents

mkl_sparse_?_export_bsr

Exports BSR matrix from internal representation.

Syntax

stat = mkl_sparse_s_export_bsr
(
source
,
indexing
,
block_layout
,
rows
,
cols
,
block_size
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_d_export_bsr
(
source
,
indexing
,
block_layout
,
rows
,
cols
,
block_size
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_c_export_bsr
(
source
,
indexing
,
block_layout
,
rows
,
cols
,
block_size
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_z_export_bsr
(
source
,
indexing
,
block_layout
,
rows
,
cols
,
block_size
,
rows_start
,
rows_end
,
col_indx
,
values
)
Include Files
  • mkl_spblas.f90
Description
If the matrix specified by the
source
handle is in BSR format, the
mkl_sparse_?_export_bsr
routine exports an
m
-by-
k
matrix
A
in BSR format from the internal representation. The routine returns pointers to the internal representation and does not allocate additional memory.
If the matrix is not already in BSR format, the routine returns
SPARSE_STATUS_INVALID_VALUE
.
Input Parameters
source
SPARSE_MATRIX_T
.
Handle containing internal data.
Output Parameters
indexing
sparse_index_base_t
.
Indicates how input arrays are indexed.
SPARSE_INDEX_BASE_ZERO
Zero-based (C-style) indexing: indices start at 0.
SPARSE_INDEX_BASE_ONE
One-based (Fortran-style) indexing: indices start at 1.
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.
rows
C_INT
.
Number of block rows of the matrix
source
.
cols
C_INT
.
Number of columns of the matrix
source
. Number of block columns of matrix
source
.
block_size
C_INT
.
Size of the block in matrix
source
.
rows_start
C_INT
.
Pointer to array of length
m
. This array contains row indices, such that
rows_start
(
i
)
-
ind
is the first index of block row
i
in the arrays
values
and
col_indx
.
ind
takes 0 for zero-based indexing and 1 for one-based indexing.
Refer to
pointerB
array description in CSR Format for more details.
rows_end
C_INT
.
Pointer to array of length
m
. This array contains row indices, such that
rows_end
(
i
)
-
ind
- 1 is the last index of block row
i
in the arrays
values
and
col_indx
.
ind
takes 0 for zero-based indexing and 1 for one-based indexing.
Refer to
pointerE
array description in CSR Format for more details.
col_indx
C_INT
.
For one-based indexing, pointer to array containing the column indices plus one for each non-zero blocks of the matrix
source
. For zero-based indexing, pointer to array containing the column indices for each non-zero blocks of the matrix
source
. Its length is