div_element_matrixdiv_element_matrixDivElementMatrixdiv_element_matrixDivElementMatrixDivElementMatrix (Operator)

Name

div_element_matrixdiv_element_matrixDivElementMatrixdiv_element_matrixDivElementMatrixDivElementMatrix — Divide matrices element-by-element.

Signature

div_element_matrix( : : MatrixAID, MatrixBID : MatrixDivID)

The operator div_element_matrixdiv_element_matrixDivElementMatrixdiv_element_matrixDivElementMatrixDivElementMatrix 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 new created output MatrixDivMatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv contains the result. The operator returns the matrix handle MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID of the matrix MatrixDivMatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv. 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:

  MatrixDiv   =  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  \
  ->    MatrixDiv = |  1.5  -7.0   0.5  |
                    \  4.5  -1.0   0.5  /

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.

MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID (output_control) matrix → (integer)

Matrix handle with the divided values of input matrices.

Result

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