Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_?_export_csr
Exports CSR matrix from internal representation.
Syntax
sparse_status_t mkl_sparse_s_export_csr ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **rows_start,
MKL_INT **rows_end,
MKL_INT **col_indx,
float **values );sparse_status_t mkl_sparse_d_export_csr ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **rows_start,
MKL_INT **rows_end,
MKL_INT **col_indx,
double **values );sparse_status_t mkl_sparse_c_export_csr ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **rows_start,
MKL_INT **rows_end,
MKL_INT **col_indx,
MKL_Complex8 **values );sparse_status_t mkl_sparse_z_export_csr ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **rows_start,
MKL_INT **rows_end,
MKL_INT **col_indx,
MKL_Complex16 **values );Include Files
mkl_spblas.h
Description
If the matrix specified by the source handle is in CSR format, the mkl_sparse_?_export_csr routine exports an rows -by- cols matrix A in CSR format matrix from the internal representation. The routine returns pointers to the internal representation and does not allocate additional memory.
In case the handle had library allocated data arrays, the users should make a copy of the exported arrays if they need to modify them or keep them beyond the lifetime of the source matrix handle, as modifying the exported arrays may lead to undefined behavior in subsequent calls to any sparse BLAS routine that uses the source handle.
If the matrix is not already in CSR format, the routine returns SPARSE_STATUS_INVALID_VALUE.
Input Parameters
source
Handle containing internal data.
Output Parameters
indexing
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
Number of rows of matrix A .
cols
Number of columns of matrix A .
rows_start
Array of length \(rows\) for 4-array format and \(rows + 1\) for 3-array format.
This array contains offset indices, such that rows_start[i] - ind is the first index of row \(i\) in the arrays values and col_indx.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing. Refer to pointerB array description in CSR Format for more details.
rows_end
Array of length \(rows\) for 4-array format and NULL or a dummy array for 3-array format.
This array contains offset indices, such that rows_end[i] - ind is one past the last index of row \(i\) in the arrays values and col_indx.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing. Refer to pointerE array description in CSR Format for more details.
col_indx
For one-based indexing, array containing the column indices plus one for each non-zero element of the matrix A . For zero-based indexing, array containing the column indices for each non-zero element of the matrix A .
Its length is at least the number of elements stored, which can be computed as rows_end[rows - 1] - ind.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing.
values
Array containing stored 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.
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. |