div_element_matrixT_div_element_matrixDivElementMatrixDivElementMatrixdiv_element_matrix (Operator)

Name

div_element_matrixT_div_element_matrixDivElementMatrixDivElementMatrixdiv_element_matrix — Divide matrices element-by-element.

Signature

div_element_matrix( : : MatrixAID, MatrixBID : MatrixDivID)

Description

The operator div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrixdiv_element_matrix divides the two matrices MatrixA and MatrixB element-by-element. The matrices are given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. It is required that both input matrices have identical dimensions. The new created output MatrixDiv contains the result. The operator returns the matrix handle MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivIDmatrix_div_id of the matrix MatrixDiv. 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.

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