ClassesClasses | | Operators

sub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod (Operator)

Name

sub_matrix_modsub_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)

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

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

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

void HMatrix.SubMatrixMod(HMatrix matrixBID)

Description

The operator sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixMod computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. 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:

  MatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBmatrixB.

Example:

Execution Information

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

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control, state is modified)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix B.

Result

If the parameters are valid, the operator sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixMod 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_matrixsub_matrixSubMatrixSubMatrixSubMatrix

See also

add_matrixadd_matrixAddMatrixAddMatrixAddMatrix, add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixMod

Module

Foundation


ClassesClasses | | Operators