mult_element_matrix_modT_mult_element_matrix_modMultElementMatrixModMultElementMatrixModmult_element_matrix_mod (Operator)

Name

mult_element_matrix_modT_mult_element_matrix_modMultElementMatrixModMultElementMatrixModmult_element_matrix_mod — Multiply matrices element-by-element.

Signature

mult_element_matrix_mod( : : MatrixAID, MatrixBID : )

Description

The operator mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixModmult_element_matrix_mod multiplies the two matrices MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a and MatrixBMatrixBMatrixBMatrixBmatrixBmatrix_b 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. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a is overwritten with the result. 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.

This operator modifies the state of the following input parameter:

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid (input_control) matrix → (handle)

Matrix handle of the input matrix B.

Result

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