div_element_matrixT_div_element_matrixDivElementMatrixDivElementMatrix (Operator)

Name

div_element_matrixT_div_element_matrixDivElementMatrixDivElementMatrix — Divide matrices element-by-element.

Signature

div_element_matrix( : : MatrixAID, MatrixBID : MatrixDivID)

Description

The operator div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrix divides the two matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices have identical dimensions. The new created output MatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv contains the result. The operator returns the matrix handle MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID of the matrix MatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv. 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 → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (handle)

Matrix handle of the input matrix B.

MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID (output_control) matrix → (handle)

Matrix handle with the divided values of input matrices.

Result

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