Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_?_dense2coo
Conversion of the adns dense matrix to COO format in dest matrix handle.
Syntax
sparse_status_t mkl_sparse_s_dense2coo ( const MKL_INT rows,
const MKL_INT cols,
const sparse_layout_t dense_layout,
const MKL_INT lda,
const float *adns,
const sparse_index_base_t indexing,
const struct matrix_descr descr,
sparse_matrix_t *dest );sparse_status_t mkl_sparse_d_dense2coo ( const MKL_INT rows,
const MKL_INT cols,
const sparse_layout_t dense_layout,
const MKL_INT lda,
const double *adns,
const sparse_index_base_t indexing,
const struct matrix_descr descr,
sparse_matrix_t *dest );sparse_status_t mkl_sparse_c_dense2coo ( const MKL_INT rows,
const MKL_INT cols,
const sparse_layout_t dense_layout,
const MKL_INT lda,
const MKL_Complex8 *adns,
const sparse_index_base_t indexing,
const struct matrix_descr descr,
sparse_matrix_t *dest );sparse_status_t mkl_sparse_z_dense2coo ( const MKL_INT rows,
const MKL_INT cols,
const sparse_layout_t dense_layout,
const MKL_INT lda,
const MKL_Complex16 *adns,
const sparse_index_base_t indexing,
const struct matrix_descr descr,
sparse_matrix_t *dest );Include Files
mkl_spblas.h
Description
The mkl_sparse_?_dense2coo routine creates a handle for a sparse matrix in Coordinate (COO) format from a dense matrix representation. Only non-zero elements are stored in the resulting sparse matrix.
See also mkl_sparse_?_convert_dense for the reverse operation (sparse to dense).
Input Parameters
rows
Number of rows of the dense matrix.
cols
Number of columns of the dense matrix.
dense_layout
Describes the storage scheme for the dense matrix:
SPARSE_LAYOUT_COLUMN_MAJOR |
Storage of elements uses column-major layout. |
SPARSE_LAYOUT_ROW_MAJOR |
Storage of elements uses row-major layout. |
lda
Leading dimension of the dense matrix. For column-major layout, must be at least rows. For row-major layout, must be at least cols.
adns
Array containing elements of the dense matrix. It is expected that the size of the array is at least lda * cols for column-major layout or lda * rows for row-major layout.
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. |
descr
Descriptor specifying sparse matrix properties.
sparse_matrix_type_t type |
Specifies the type of a sparse matrix:
|
sparse_fill_mode_t mode |
Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices:
|
sparse_diag_type_t diag |
Specifies diagonal type for non-general matrices:
|
Output Parameters
dest
Pointer to handle containing internal data in COO format.
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. |