Operator Reference
div_element_matrix_mod (Operator)
div_element_matrix_mod
— Divide matrices element-by-element.
Signature
Description
The operator div_element_matrix_mod
divides the two matrices
MatrixA
and MatrixB
element-by-element. The
matrices are given by the matrix handles MatrixAID
and
MatrixBID
. It is required that both input matrices have
identical dimensions. The input matrix MatrixA
is
overwritten with the result. Access to the elements of the matrix
is possible e.g., with the operator get_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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
MatrixAID
(input_control, state is modified) matrix →
(handle)
Matrix handle of the input matrix A.
MatrixBID
(input_control) matrix →
(handle)
Matrix handle of the input matrix B.
Result
If the parameters are valid, the operator div_element_matrix_mod
returns the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
Possible Successors
get_full_matrix
,
get_value_matrix
Alternatives
See also
mult_element_matrix
,
mult_element_matrix_mod
,
scale_matrix
,
scale_matrix_mod
Module
Foundation