Developer Reference

  • 098
  • 03/30/2020
  • Public Content
Contents

mkl_sparse_?_export_csr

Exports CSR matrix from internal representation.

Syntax

stat = mkl_sparse_s_export_csr
(
source
,
indexing
,
rows
,
cols
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_d_export_csr
(
source
,
indexing
,
rows
,
cols
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_c_export_csr
(
source
,
indexing
,
rows
,
cols
,
rows_start
,
rows_end
,
col_indx
,
values
)
stat = mkl_sparse_z_export_csr
(
source
,
indexing
,
rows
,
cols
,
rows_start
,
rows_end
,
col_indx
,
values
)
Include Files
  • mkl_spblas.f90
Description
If the matrix specified by the
source
handle is in CSR format, the
mkl_sparse_?_export_csr
routine exports an
m
-by-
k
matrix
A
in CSR format matrix 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 CSR 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.
rows
C_INT
.
Number of rows of the matrix
source
.
cols
C_INT
.
Number of columns of the 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 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 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 element of the matrix
source
. For zero-based indexing, pointer to array containing the column indices for each non-zero element of the matrix
source
. Its length is
rows_end
(
rows
- 1)
-
ind
.
ind
takes 0 for zero-based indexing and 1 for one-based indexing.
values
C_FLOAT
for
mkl_sparse_s_export_csr
C_DOUBLE
for
mkl_sparse_d_export_csr
C_FLOAT_COMPLEX
for
mkl_sparse_c_export_csr
C_DOUBLE_COMPLEX
for
mkl_sparse_z_export_csr
Pointer to array containing non-zero elements of the matrix
A
. Its length is equal to length of the
col_indx
array.
Refer to
values
array description in CSR Format for more details.
Output Parameters
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.