mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrix (Operator)

Name

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrix — Multiply matrices element-by-element.

Signature

mult_element_matrix( : : MatrixAID, MatrixBID : MatrixMultID)

The operator mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrix mutiplies the two matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices have identical dimensions. A new matrix MatrixMultMatrixMultMatrixMultMatrixMultmatrixMult is generated with the result. The operator returns the matrix handle MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultID of the matrix MatrixMultMatrixMultMatrixMultMatrixMultmatrixMult. 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:

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 → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultID (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_matrixMultElementMatrixMultElementMatrixMultElementMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.