ClassesClassesClassesClasses | | | | Operators

sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod (Operator)

Name

sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod — Subtract two matrices.

Signature

sub_matrix_mod( : : MatrixAID, MatrixBID : )

Herror sub_matrix_mod(const Hlong MatrixAID, const Hlong MatrixBID)

Herror T_sub_matrix_mod(const Htuple MatrixAID, const Htuple MatrixBID)

Herror sub_matrix_mod(const HTuple& MatrixAID, const HTuple& MatrixBID)

void HMatrix::SubMatrixMod(const HMatrix& MatrixBID) const

void SubMatrixMod(const HTuple& MatrixAID, const HTuple& MatrixBID)

void HMatrix::SubMatrixMod(const HMatrix& MatrixBID) const

void HOperatorSetX.SubMatrixMod(
[in] VARIANT MatrixAID, [in] VARIANT MatrixBID)

void HMatrixX.SubMatrixMod([in] IHMatrixX* MatrixBID)

static void HOperatorSet.SubMatrixMod(HTuple matrixAID, HTuple matrixBID)

void HMatrix.SubMatrixMod(HMatrix matrixBID)

Description

The operator sub_matrix_modsub_matrix_modSubMatrixModsub_matrix_modSubMatrixModSubMatrixMod computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. 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:

  MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBMatrixBmatrixB.

Example:

Parallelization

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control, state is modified)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix B.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Alternatives

sub_matrixsub_matrixSubMatrixsub_matrixSubMatrixSubMatrix

See also

add_matrixadd_matrixAddMatrixadd_matrixAddMatrixAddMatrix, add_matrix_modadd_matrix_modAddMatrixModadd_matrix_modAddMatrixModAddMatrixMod

Module

Foundation


ClassesClassesClassesClasses | | | | Operators