add_matrixT_add_matrixAddMatrixAddMatrix (Operator)

Name

add_matrixT_add_matrixAddMatrixAddMatrix — Add two matrices.

Signature

add_matrix( : : MatrixAID, MatrixBID : MatrixSumID)

Description

The operator add_matrixadd_matrixAddMatrixAddMatrixAddMatrix computes the sum of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. A new matrix MatrixSumMatrixSumMatrixSumMatrixSummatrixSum is generated with the result. The operator returns the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID of the matrix MatrixSumMatrixSumMatrixSumMatrixSummatrixSum. 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: MatrixSumMatrixSumMatrixSumMatrixSummatrixSum = 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.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (handle)

Matrix handle of the input matrix B.

MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID (output_control) matrix → (handle)

Matrix handle with the sum of the input matrices.

Result

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