sub_matrix_modT_sub_matrix_modSubMatrixModSubMatrixModsub_matrix_mod (Operator)

Name

sub_matrix_modT_sub_matrix_modSubMatrixModSubMatrixModsub_matrix_mod — Subtract two matrices.

Signature

sub_matrix_mod( : : MatrixAID, MatrixBID : )

Description

The operator sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixModsub_matrix_mod computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a and MatrixBMatrixBMatrixBMatrixBmatrixBmatrix_b given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is: MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a = MatrixAMatrixAMatrixAMatrixAmatrixAmatrix_a - MatrixBMatrixBMatrixBMatrixBmatrixBmatrix_b.

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:

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid (input_control) matrix → (handle)

Matrix handle of the input matrix B.

Result

If the parameters are valid, the operator sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixModsub_matrix_mod returns the value TRUE. If necessary, an exception is raised.