div_element_matrix_moddiv_element_matrix_modDivElementMatrixModdiv_element_matrix_modDivElementMatrixModDivElementMatrixMod (Operator)

Name

div_element_matrix_moddiv_element_matrix_modDivElementMatrixModdiv_element_matrix_modDivElementMatrixModDivElementMatrixMod — Divide matrices element-by-element.

Signature

div_element_matrix_mod( : : MatrixAID, MatrixBID : )

The operator div_element_matrix_moddiv_element_matrix_modDivElementMatrixModdiv_element_matrix_modDivElementMatrixModDivElementMatrixMod divides the two matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

  MatrixA   =  MatrixA    / MatrixB  .
         ij           ij           ij

Example:


            /   4.0   8.0   0.0  \                /   2.0   8.0  -3.0  \
  MatrixA = |  -6.0   7.0   2.0  |      MatrixB = |  -4.0  -1.0   4.0  |
            \  -9.0   4.0   1.0  /                \  -2.0  -4.0   2.0  /

                  /  2.0   1.0   0.0  \
  ->    MatrixA = |  1.5  -7.0   0.5  |
                  \  4.5  -1.0   0.5  /

Attention

div_element_matrix_moddiv_element_matrix_modDivElementMatrixModdiv_element_matrix_modDivElementMatrixModDivElementMatrixMod modifies the content of an already existing matrix.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

Result

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