Name
sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod — Subtract two matrices.
The operator sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod computes the difference of the input
matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix
handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices
must 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:
MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB.
Example:
- 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:
The value of this parameter may not be shared across multiple threads without external synchronization.
Matrix handle of the input matrix A.
Matrix handle of the input matrix B.
If the parameters are valid, the operator sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod returns
the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix
get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix,
get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix
sub_matrixsub_matrixSubMatrixsub_matrixSubMatrixSubMatrix
add_matrixadd_matrixAddMatrixadd_matrixAddMatrixAddMatrix,
add_matrix_modadd_matrix_modAddMatrixModadd_matrix_modAddMatrixModAddMatrixMod
Foundation