Intel® Math Kernel Library 2018 Developer Reference - C

mkl_sparse_?_add

Computes sum of two sparse matrices.

Syntax

sparse_status_t mkl_sparse_s_add (sparse_operation_t operation, const sparse_matrix_t A, float alpha, const sparse_matrix_t B, sparse_matrix_t *C);

sparse_status_t mkl_sparse_d_add (sparse_operation_t operation, const sparse_matrix_t A, double alpha, const sparse_matrix_t B, sparse_matrix_t *C);

sparse_status_t mkl_sparse_c_add (sparse_operation_t operation, const sparse_matrix_t A, MKL_Complex8 alpha, const sparse_matrix_t B, sparse_matrix_t *C);

sparse_status_t mkl_sparse_z_add (sparse_operation_t operation, const sparse_matrix_t A, MKL_Complex16 alpha, const sparse_matrix_t B, sparse_matrix_t *C);

Include Files

Description

The mkl_sparse_?_add routine performs a matrix-matrix operation:

C := alpha*op(A) + B

where alpha is a scalar and A, B, and C are sparse matrices.

Input Parameters

A

Handle containing a sparse matrix in internal data structure.

alpha

Specifies the scalar alpha.

operation

Specifies operation op() on input matrix.

SPARSE_OPERATION_NON_TRANSPOSE

Non-transpose, op(A) = A.

SPARSE_OPERATION_TRANSPOSE

Transpose, op(A) = AT.

SPARSE_OPERATION_CONJUGATE_TRANSPOSE

Conjugate transpose, op(A) = AH.

B

Handle containing a sparse matrix in internal data structure.

Output Parameters

C

Handle containing the resulting sparse matrix in internal data structure.

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.