add_matrixT_add_matrixAddMatrixAddMatrix (Operator)

Name

add_matrixT_add_matrixAddMatrixAddMatrix — Add two matrices.

Signature

add_matrix( : : MatrixAID, MatrixBID : MatrixSumID)

Herror T_add_matrix(const Htuple MatrixAID, const Htuple MatrixBID, Htuple* MatrixSumID)

void AddMatrix(const HTuple& MatrixAID, const HTuple& MatrixBID, HTuple* MatrixSumID)

HMatrix HMatrix::AddMatrix(const HMatrix& MatrixBID) const

static void HOperatorSet.AddMatrix(HTuple matrixAID, HTuple matrixBID, out HTuple matrixSumID)

HMatrix HMatrix.AddMatrix(HMatrix matrixBID)

Description

The operator add_matrixadd_matrixAddMatrixAddMatrixAddMatrix computes the sum of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. A new matrix MatrixSumMatrixSumMatrixSumMatrixSummatrixSum is generated with the result. The operator returns the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID of the matrix MatrixSumMatrixSumMatrixSumMatrixSummatrixSum. 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: MatrixSumMatrixSumMatrixSumMatrixSummatrixSum = 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.

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

Matrix handle with the sum of the input matrices.

Result

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

add_matrix_modadd_matrix_modAddMatrixModAddMatrixModAddMatrixMod

See also

sub_matrixsub_matrixSubMatrixSubMatrixSubMatrix, sub_matrix_modsub_matrix_modSubMatrixModSubMatrixModSubMatrixMod

Module

Foundation