sub_matrix_mod T_sub_matrix_mod SubMatrixMod SubMatrixMod sub_matrix_mod (Operator)
Name
sub_matrix_mod T_sub_matrix_mod SubMatrixMod SubMatrixMod sub_matrix_mod
— Subtract two matrices.
Signature
Description
The operator sub_matrix_mod sub_matrix_mod SubMatrixMod SubMatrixMod SubMatrixMod sub_matrix_mod
computes the difference of the input
matrices MatrixA
and MatrixB
given by the matrix
handles MatrixAID MatrixAID MatrixAID MatrixAID matrixAID matrix_aid
and MatrixBID MatrixBID MatrixBID MatrixBID matrixBID matrix_bid
. Both matrices
must 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 sub_matrix_mod sub_matrix_mod SubMatrixMod SubMatrixMod SubMatrixMod sub_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
sub_matrix sub_matrix SubMatrix SubMatrix SubMatrix sub_matrix
See also
add_matrix add_matrix AddMatrix AddMatrix AddMatrix add_matrix
,
add_matrix_mod add_matrix_mod AddMatrixMod AddMatrixMod AddMatrixMod add_matrix_mod
Module
Foundation