sub_matrixsub_matrixSubMatrixsub_matrixSubMatrixSubMatrix (Operator)

Name

sub_matrixsub_matrixSubMatrixsub_matrixSubMatrixSubMatrix — Subtract two matrices.

Signature

sub_matrix( : : MatrixAID, MatrixBID : MatrixSubID)

The operator sub_matrixsub_matrixSubMatrixsub_matrixSubMatrixSubMatrix computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. A new matrix MatrixSubMatrixSubMatrixSubMatrixSubMatrixSubmatrixSub is generated with the result. The operator returns the matrix handle MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubID of the matrix MatrixSubMatrixSubMatrixSubMatrixSubMatrixSubmatrixSub. 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:

  MatrixSubMatrixSubMatrixSubMatrixSubMatrixSubmatrixSub = MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB.

Example:

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubID (output_control) matrix → (integer)

Matrix handle with the difference of the input matrices.

Result

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