sub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod (Operator)

Name

sub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod — Subtract two matrices.

Signature

sub_matrix_mod( : : MatrixAID, MatrixBID : )

The operator sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixMod computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

  MatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBmatrixB.

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:

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control, state is modified) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

Result

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