mult_element_matrixmult_element_matrixMultElementMatrixmult_element_matrixMultElementMatrixMultElementMatrix (Operator)

Name

mult_element_matrixmult_element_matrixMultElementMatrixmult_element_matrixMultElementMatrixMultElementMatrix — Multiply matrices element-by-element.

Signature

mult_element_matrix( : : MatrixAID, MatrixBID : MatrixMultID)

The operator mult_element_matrixmult_element_matrixMultElementMatrixmult_element_matrixMultElementMatrixMultElementMatrix 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. A new matrix MatrixMultMatrixMultMatrixMultMatrixMultMatrixMultmatrixMult is generated with the result. The operator returns the matrix handle MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultID of the matrix MatrixMultMatrixMultMatrixMultMatrixMultMatrixMultmatrixMult. 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:

  MatrixMult   =  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  \
  ->    MatrixMult = |  24.0   -7.0   8.0  |
                     \  18.0  -16.0   2.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.

MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultID (output_control) matrix → (integer)

Matrix handle with the multiplied values of the input matrices.

Result

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