mkl_sparse_?_create_csr
mkl_sparse_?_create_csr
Creates a handle for a CSR-format matrix.
Syntax
sparse_status_t mkl_sparse_s_create_csr
(
sparse_matrix_t
*A
,
const sparse_index_base_t
indexing
,
const MKL_INT
rows
,
const MKL_INT
cols
,
MKL_INT
*rows_start
,
MKL_INT
*rows_end
,
MKL_INT
*col_indx
,
float
*values
);
sparse_status_t mkl_sparse_d_create_csr
(
sparse_matrix_t
*A
,
const sparse_index_base_t
indexing
,
const MKL_INT
rows
,
const MKL_INT
cols
,
MKL_INT
*rows_start
,
MKL_INT
*rows_end
,
MKL_INT
*col_indx
,
double
*values
);
sparse_status_t mkl_sparse_c_create_csr
(
sparse_matrix_t
*A
,
const sparse_index_base_t
indexing
,
const MKL_INT
rows
,
const MKL_INT
cols
,
MKL_INT
*rows_start
,
MKL_INT
*rows_end
,
MKL_INT
*col_indx
,
MKL_Complex8
*values
);
sparse_status_t mkl_sparse_z_create_csr
(
sparse_matrix_t
*A
,
const sparse_index_base_t
indexing
,
const MKL_INT
rows
,
const MKL_INT
cols
,
MKL_INT
*rows_start
,
MKL_INT
*rows_end
,
MKL_INT
*col_indx
,
MKL_Complex16
*values
);
Include Files
- mkl_spblas.h
Description
The
mkl_sparse_?_create_csr
routine creates a handle for
an m
-by-k
matrix A
in CSR format.The input arrays provided are left unchanged except for the call to mkl_sparse_order, which performs ordering of column indexes of the matrix. To avoid any changes to the input data, use mkl_sparse_copy.
Input 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 matrixA.
- cols
- Number of columns of matrixA.
- rows_start
- Arrayof length at leastrows. This array contains row indices, such thatrows_start[-i]indexingis the first index of rowiin the arraysvaluesandcol_indx. The value ofindexingis 0 for zero-based indexing and 1 for one-based indexing.Refer topointerBarray description in CSR Format for more details.
- rows_end
- Arrayof at least lengthrows. This array contains row indices, such thatrows_end[-i]indexing- 1is the last index of rowiin the arraysvaluesandcol_indx. The value ofindexingis 0 for zero-based indexing and 1 for one-based indexing.Refer topointerEarray 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 matrixA. For zero-based indexing, array containing the column indices for each non-zero element of the matrixA. Its length is at leastrows_end[-rows- 1]indexing.The value ofindexingis 0 for zero-based indexing and 1 for one-based indexing.
- values
- Arraycontaining non-zero elements of the matrixA. Its length is equal to length of thecol_indxarray.Refer tovaluesarray description in CSR Format for more details.
Output Parameters
- A
- Handle containing internal data for subsequent Inspector-executor Sparse BLAS operations.
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.