sub_matrixT_sub_matrixSubMatrixSubMatrixsub_matrix (Operator)

Name

sub_matrixT_sub_matrixSubMatrixSubMatrixsub_matrix — Subtract two matrices.

Signature

sub_matrix( : : MatrixAID, MatrixBID : MatrixSubID)

Description

The operator sub_matrixsub_matrixSubMatrixSubMatrixsub_matrix computes the difference of the input matrices MatrixA and MatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. Both matrices must have identical dimensions. A new matrix MatrixSub is generated with the result. The operator returns the matrix handle MatrixSubIDMatrixSubIDMatrixSubIDmatrixSubIDmatrix_sub_id of the matrix MatrixSub. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

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

MatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid (input_control) matrix → (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid (input_control) matrix → (handle)

Matrix handle of the input matrix B.

MatrixSubIDMatrixSubIDMatrixSubIDmatrixSubIDmatrix_sub_id (output_control) matrix → (handle)

Matrix handle with the difference of the input matrices.

Result

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