mult_element_matrix_mod T_mult_element_matrix_mod MultElementMatrixMod MultElementMatrixMod mult_element_matrix_mod (Operator)
Name
mult_element_matrix_mod T_mult_element_matrix_mod MultElementMatrixMod MultElementMatrixMod mult_element_matrix_mod
— Multiply matrices element-by-element.
Signature
Description
The operator mult_element_matrix_mod mult_element_matrix_mod MultElementMatrixMod MultElementMatrixMod MultElementMatrixMod mult_element_matrix_mod
multiplies the two
matrices MatrixA
and MatrixB
element-by-element.
The matrices are defined by the matrix handles MatrixAID MatrixAID MatrixAID MatrixAID matrixAID matrix_aid
and MatrixBID MatrixBID MatrixBID MatrixBID matrixBID matrix_bid
. 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 get_full_matrix GetFullMatrix GetFullMatrix GetFullMatrix 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 MatrixAID MatrixAID MatrixAID matrixAID matrix_aid
(input_control, state is modified) matrix →
HMatrix , HTuple HHandle HTuple Htuple (handle) (IntPtr ) (HHandle ) (handle )
Matrix handle of the input matrix A.
MatrixBID MatrixBID MatrixBID MatrixBID matrixBID matrix_bid
(input_control) matrix →
HMatrix , HTuple HHandle HTuple Htuple (handle) (IntPtr ) (HHandle ) (handle )
Matrix handle of the input matrix B.
Result
If the parameters are valid, the operator
mult_element_matrix_mod mult_element_matrix_mod MultElementMatrixMod MultElementMatrixMod MultElementMatrixMod mult_element_matrix_mod
returns the value 2 (
H_MSG_TRUE )
. If necessary,
an exception is raised.
Possible Predecessors
create_matrix create_matrix CreateMatrix CreateMatrix CreateMatrix create_matrix
Possible Successors
get_full_matrix get_full_matrix GetFullMatrix GetFullMatrix GetFullMatrix get_full_matrix
,
get_value_matrix get_value_matrix GetValueMatrix GetValueMatrix GetValueMatrix get_value_matrix
Alternatives
mult_element_matrix mult_element_matrix MultElementMatrix MultElementMatrix MultElementMatrix mult_element_matrix
See also
div_element_matrix div_element_matrix DivElementMatrix DivElementMatrix DivElementMatrix div_element_matrix
,
div_element_matrix_mod div_element_matrix_mod DivElementMatrixMod DivElementMatrixMod DivElementMatrixMod div_element_matrix_mod
,
scale_matrix scale_matrix ScaleMatrix ScaleMatrix ScaleMatrix scale_matrix
,
scale_matrix_mod scale_matrix_mod ScaleMatrixMod ScaleMatrixMod ScaleMatrixMod scale_matrix_mod
Module
Foundation