mkl_sparse_?_export

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 6/30/2025

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.

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 the matrix source.

cols

Number of columns of the matrix source.

nnz

Number of non-zero elements of the matrix source.

rows_indx

Pointer to array of length rows. This array contains row indices, such that rows_start[i] - ind is the first index of row i in the arrays values and cols_indx. ind takes 0 for zero-based indexing and 1 for one-based indexing.

Refer to the COO Format description for more details.

cols_indx

Pointer to an array of length nnz. This array contains the column indices such that cols_indx[i] is the column index of element i in COO representation. The array is indexed according to the value returned by the indexing variable.

Refer to the COO Format description for more details.

values

Pointer to an array of length nnz. This array contains the values of the matrix A, such that values[i] is the value of element i in COO representation.

Refer to the COO Format description 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.

Parent topic: Matrix Manipulation Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

mkl_sparse_?_export_coo

Syntax

Include Files

Description

Input Parameters

Output Parameters

Return Values