Operator Reference

mult_element_matrixT_mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix (Operator)

mult_element_matrixT_mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix — Multiply matrices element-by-element.

Signature

mult_element_matrix( : : MatrixAID, MatrixBID : MatrixMultID)

Herror T_mult_element_matrix(const Htuple MatrixAID, const Htuple MatrixBID, Htuple* MatrixMultID)

void MultElementMatrix(const HTuple& MatrixAID, const HTuple& MatrixBID, HTuple* MatrixMultID)

HMatrix HMatrix::MultElementMatrix(const HMatrix& MatrixBID) const

static void HOperatorSet.MultElementMatrix(HTuple matrixAID, HTuple matrixBID, out HTuple matrixMultID)

HMatrix HMatrix.MultElementMatrix(HMatrix matrixBID)

def mult_element_matrix(matrix_aid: HHandle, matrix_bid: HHandle) -> HHandle

Description

The operator mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix multiplies the two matrices MatrixA and MatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. It is required that both input matrices have identical dimensions. A new matrix MatrixMult is generated with the result. The operator returns the matrix handle MatrixMultIDMatrixMultIDMatrixMultIDmatrixMultIDmatrix_mult_id of the matrix MatrixMult. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

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

Matrix handle of the input matrix A.

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

Matrix handle of the input matrix B.

MatrixMultIDMatrixMultIDMatrixMultIDmatrixMultIDmatrix_mult_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the multiplied values of the input matrices.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModmult_element_matrix_mod

See also

div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixdiv_element_matrix, div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod, scale_matrixscale_matrixScaleMatrixScaleMatrixscale_matrix, scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModscale_matrix_mod

Module

Foundation