mkl_sparse_?_export

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 4/28/2026

Version

Public

mkl_sparse_?_export_coo

Exports COO matrix from internal representation.

Syntax

sparse_status_t mkl_sparse_s_export_coo (const sparse_matrix_t source,
                                               sparse_index_base_t *indexing,
                                               MKL_INT *rows,
                                               MKL_INT *cols,
                                               MKL_INT *nnz,
                                               MKL_INT **rows_indx,
                                               MKL_INT **cols_indx,
                                               float **values);

sparse_status_t mkl_sparse_d_export_coo (const sparse_matrix_t source,
                                               sparse_index_base_t *indexing,
                                               MKL_INT *rows,
                                               MKL_INT *cols,
                                               MKL_INT *nnz,
                                               MKL_INT **rows_indx,
                                               MKL_INT **cols_indx,
                                               double **values);

sparse_status_t mkl_sparse_c_export_coo (const sparse_matrix_t source,
                                               sparse_index_base_t *indexing,
                                               MKL_INT *rows,
                                               MKL_INT *cols,
                                               MKL_INT *nnz,
                                               MKL_INT **rows_indx,
                                               MKL_INT **cols_indx,
                                               MKL_Complex8 **values);

sparse_status_t mkl_sparse_z_export_coo (const sparse_matrix_t source,
                                               sparse_index_base_t *indexing,
                                               MKL_INT *rows,
                                               MKL_INT *cols,
                                               MKL_INT *nnz,
                                               MKL_INT **rows_indx,
                                               MKL_INT **cols_indx,
                                               MKL_Complex16 **values);

Include Files

mkl_spblas.h

Description

If the matrix specified by the source handle is in Coordinate (COO) format, the mkl_sparse_?_export_coo routine exports a rows -by- cols matrix A using COO as 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 COO 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 .

nnz

Specifies the number of stored elements (sometimes called the non-zero elements, but they can be explicit zeros) of the matrix \(A\) . Refer to nnz description in Coordinate Format for more details.

row_indx

Array of length nnz, containing the row indices for each stored element of matrix \(A\) . Refer to rows array description in Coordinate Format for more details.

col_indx

Array of length nnz , containing the column indices for each non-zero element of matrix \(A\) . Refer to columns array description in Coordinate Format for more details.

values

Array of length nnz , containing the stored elements of matrix A. Refer to values array description in Coordinate 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.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in