mult_element_matrix_modmult_element_matrix_modMultElementMatrixModmult_element_matrix_modMultElementMatrixModMultElementMatrixMod (Operator)

Name

mult_element_matrix_modmult_element_matrix_modMultElementMatrixModmult_element_matrix_modMultElementMatrixModMultElementMatrixMod — Multiply matrices element-by-element.

Signature

mult_element_matrix_mod( : : MatrixAID, MatrixBID : )

The operator mult_element_matrix_modmult_element_matrix_modMultElementMatrixModmult_element_matrix_modMultElementMatrixModMultElementMatrixMod mutiplies the two matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. 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:

  MatrixA   =  MatrixA    * MatrixB  .
         ij           ij           ij

Example:


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

                  /   8.0   64.0   0.0  \
  ->    MatrixA = |  24.0   -7.0   8.0  |
                  \  18.0  -16.0   2.0  /

Attention

mult_element_matrix_modmult_element_matrix_modMultElementMatrixModmult_element_matrix_modMultElementMatrixModMultElementMatrixMod modifies the content of an already existing matrix.

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.

Result

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