add_matrix_modT_add_matrix_modAddMatrixModAddMatrixMod (Operator)

Name

add_matrix_modT_add_matrix_modAddMatrixModAddMatrixMod — Add two matrices.

Signature

add_matrix_mod( : : MatrixAID, MatrixBID : )

Description

The operator add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixMod computes the sum of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is: MatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAmatrixA + MatrixBMatrixBMatrixBMatrixBmatrixB.

Example:

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (handle)

Matrix handle of the input matrix B.

Result

If the parameters are valid, the operator add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixMod returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.