Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_?_export_csc
Exports CSC matrix from internal representation.
Syntax
sparse_status_t mkl_sparse_s_export_csc ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **cols_start,
MKL_INT **cols_end,
MKL_INT **row_indx,
float **values );sparse_status_t mkl_sparse_d_export_csc ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **cols_start,
MKL_INT **cols_end,
MKL_INT **row_indx,
double **values );sparse_status_t mkl_sparse_c_export_csc ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **cols_start,
MKL_INT **cols_end,
MKL_INT **row_indx,
MKL_Complex8 **values );sparse_status_t mkl_sparse_z_export_csc ( const sparse_matrix_t source,
sparse_index_base_t *indexing,
MKL_INT *rows,
MKL_INT *cols,
MKL_INT **cols_start,
MKL_INT **cols_end,
MKL_INT **row_indx,
MKL_Complex16 **values );Include Files
mkl_spblas.h
Description
If the matrix specified by the source handle is in CSC format, the mkl_sparse_?_export_csc routine exports an \(m\) -by- \(k\) matrix A in CSC 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 CSC 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 .
cols_start
Array of length \(cols\) for 4-array format and \(cols + 1\) for 3-array format.
This array contains offset indices, such that cols_start[i] - ind is the first index of column \(i\) in the arrays values and row_indx.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing. Refer to pointerB array description in CSC Format for more details.
cols_end
Array of length \(cols\) for 4-array format and NULL or a dummy array for 3-array format.
This array contains offset indices, such that cols_end[i] - ind is one past the last index of column \(i\) in the arrays values and row_indx.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing. Refer to pointerE array description in CSC Format for more details.
row_indx
For one-based indexing, array containing the row indices plus one for each non-zero element of the matrix A . For zero-based indexing, array containing the row 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 cols_end[cols - 1] - ind.
Here, ind takes a value of \(0\) for zero-based indexing and \(1\) for one-based indexing.
values
Array containing non-stored elements (non-zeros and explicit zeros) of the matrix A . Its length is equal to length of the row_indx array. Refer to values array description in CSC 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. |