sub_matrixsub_matrixSubMatrixSubMatrix (Operator)

Name

sub_matrixsub_matrixSubMatrixSubMatrix — Subtract two matrices.

Signature

sub_matrix( : : MatrixAID, MatrixBID : MatrixSubID)

The operator sub_matrixsub_matrixSubMatrixSubMatrixSubMatrix computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. A new matrix MatrixSubMatrixSubMatrixSubMatrixSubmatrixSub is generated with the result. The operator returns the matrix handle MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubID of the matrix MatrixSubMatrixSubMatrixSubMatrixSubmatrixSub. 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:

  MatrixSubMatrixSubMatrixSubMatrixSubmatrixSub = 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.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubID (output_control) matrix → (integer)

Matrix handle with the difference of the input matrices.

Result

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