add_matrixadd_matrixAddMatrixadd_matrixAddMatrixAddMatrix (Operator)

Name

add_matrixadd_matrixAddMatrixadd_matrixAddMatrixAddMatrix — Add two matrices.

Signature

add_matrix( : : MatrixAID, MatrixBID : MatrixSumID)

The operator add_matrixadd_matrixAddMatrixadd_matrixAddMatrixAddMatrix computes the sum of the input matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. A new matrix MatrixSumMatrixSumMatrixSumMatrixSumMatrixSummatrixSum is generated with the result. The operator returns the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID of the matrix MatrixSumMatrixSumMatrixSumMatrixSumMatrixSummatrixSum. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

  MatrixSumMatrixSumMatrixSumMatrixSumMatrixSummatrixSum = MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA + MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB.

Example:


            /   3.0   1.0  -2.0  \                /   2.0   8.0  -3.0  \
  MatrixA = |  -5.0   7.0   2.0  |      MatrixB = |  -4.0  -1.0   5.0  |
            \  -9.0  -4.0   1.0  /                \   2.0  -4.0   7.0  /

                   /   5.0   9.0  -5.0  \
  ->   MatrixSum = |  -9.0   6.0   7.0  |
                   \  -7.0  -8.0   8.0  /

Parallelization

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

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID (output_control) matrix → (integer)

Matrix handle with the sum of the input matrices.

Result

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