add_matrix_modT_add_matrix_modAddMatrixModAddMatrixModadd_matrix_mod (Operator)

Name

add_matrix_modT_add_matrix_modAddMatrixModAddMatrixModadd_matrix_mod — Add two matrices.

Signature

add_matrix_mod( : : MatrixAID, MatrixBID : )

Herror T_add_matrix_mod(const Htuple MatrixAID, const Htuple MatrixBID)

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

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

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

void HMatrix.AddMatrixMod(HMatrix matrixBID)

def add_matrix_mod(matrix_aid: HHandle, matrix_bid: HHandle) -> None

Description

The operator add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixModadd_matrix_mod computes the sum of the input matrices MatrixA and MatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. Both matrices must have identical dimensions. The input matrix MatrixA is overwritten with the result. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is: \texttt{MatrixA} = \texttt{MatrixA} + \texttt{MatrixB}.

Example:

Execution Information

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid (input_control, state is modified)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix B.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

add_matrixadd_matrixAddMatrixAddMatrixAddMatrixadd_matrix

See also

sub_matrixsub_matrixSubMatrixSubMatrixSubMatrixsub_matrix, sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixModsub_matrix_mod

Module

Foundation