mkl_sparse_copy
mkl_sparse_copy
Creates a copy of a matrix handle.
Syntax
sparse_status_t mkl_sparse_copy
(
const
sparse_matrix_t
source
,
const struct
matrix_descr
descr
,
sparse_matrix_t
*dest
);
Include Files
- mkl_spblas.h
Description
The
mkl_sparse_copy
routine creates a copy of a matrix handle.Input Parameters
- source
- Specifies handle containing internal data.
- descr
- Structurespecifying sparse matrix properties.sparse_matrix_type_ttype- Specifies the type of a sparse matrix:
- SPARSE_MATRIX_TYPE_GENERAL
- The matrix is processed as is.
- SPARSE_MATRIX_TYPE_SYMMETRIC
- The matrix is symmetric (only the requested triangle is processed).
- SPARSE_MATRIX_TYPE_HERMITIAN
- The matrix is Hermitian (only the requested triangle is processed).
- SPARSE_MATRIX_TYPE_TRIANGULAR
- The matrix is triangular (only the requested triangle is processed).
- SPARSE_MATRIX_TYPE_DIAGONAL
- The matrix is diagonal (only diagonal elements are processed).
- SPARSE_MATRIX_TYPE_BLOCK_TRIANGULAR
- The matrix is block-triangular (only requested triangle is processed). Applies to BSR format only.
- SPARSE_MATRIX_TYPE_BLOCK_DIAGONAL
- The matrix is block-diagonal (only diagonal blocks are processed). Applies to BSR format only.
sparse_fill_mode_tmode- Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices:- SPARSE_FILL_MODE_LOWER
- The lower triangular matrix part is processed.
- SPARSE_FILL_MODE_UPPER
- The upper triangular matrix part is processed.
sparse_diag_type_tdiag- Specifies diagonal type for non-general matrices:- SPARSE_DIAG_NON_UNIT
- Diagonal elements might not be equal to one.
- SPARSE_DIAG_UNIT
- Diagonal elements are equal to one.
Output Parameters
- dest
- Handle containing internal data.
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.