mult_element_matrixT_mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix (Operator)

Name

mult_element_matrixT_mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix — Multiply matrices element-by-element.

Signature

mult_element_matrix( : : MatrixAID, MatrixBID : MatrixMultID)

Description

The operator mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrixmult_element_matrix multiplies the two matrices MatrixA and MatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. It is required that both input matrices have identical dimensions. A new matrix MatrixMult is generated with the result. The operator returns the matrix handle MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultIDmatrix_mult_id of the matrix MatrixMult. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. 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

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid (input_control) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid (input_control) matrix → (handle)

Matrix handle of the input matrix B.

MatrixMultIDMatrixMultIDMatrixMultIDMatrixMultIDmatrixMultIDmatrix_mult_id (output_control) matrix → (handle)

Matrix handle with the multiplied values of the input matrices.

Result

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