sub_matrixT_sub_matrixSubMatrixSubMatrix (Operator)

Name

sub_matrixT_sub_matrixSubMatrixSubMatrix — Subtract two matrices.

Signature

sub_matrix( : : MatrixAID, MatrixBID : MatrixSubID)

Herror T_sub_matrix(const Htuple MatrixAID, const Htuple MatrixBID, Htuple* MatrixSubID)

void SubMatrix(const HTuple& MatrixAID, const HTuple& MatrixBID, HTuple* MatrixSubID)

HMatrix HMatrix::SubMatrix(const HMatrix& MatrixBID) const

static void HOperatorSet.SubMatrix(HTuple matrixAID, HTuple matrixBID, out HTuple matrixSubID)

HMatrix HMatrix.SubMatrix(HMatrix matrixBID)

Description

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

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix B.

MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubID (output_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

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.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixMod

See also

add_matrixadd_matrixAddMatrixAddMatrixAddMatrix, add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixMod

Module

Foundation