mult_element_matrix_modT_mult_element_matrix_modMultElementMatrixModMultElementMatrixMod (Operator)

Name

mult_element_matrix_modT_mult_element_matrix_modMultElementMatrixModMultElementMatrixMod — Multiply matrices element-by-element.

Signature

mult_element_matrix_mod( : : MatrixAID, MatrixBID : )

Herror T_mult_element_matrix_mod(const Htuple MatrixAID, const Htuple MatrixBID)

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

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

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

void HMatrix.MultElementMatrixMod(HMatrix matrixBID)

Description

The operator mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixMod mutiplies the two matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices 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:

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

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control, state is modified)  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.

Result

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

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrix

See also

div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrix, div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixMod, scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrix, scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixMod

Module

Foundation