Skip to content

mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrixT_mult_element_matrix🔗

Short description🔗

mult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrixT_mult_element_matrix — Multiply matrices element-by-element.

Signature🔗

mult_element_matrix( matrix MatrixAID, matrix MatrixBID, out matrix MatrixMultID )void MultElementMatrix( const HTuple& MatrixAID, const HTuple& MatrixBID, HTuple* MatrixMultID )static void HOperatorSet.MultElementMatrix( HTuple matrixAID, HTuple matrixBID, out HTuple matrixMultID )def mult_element_matrix( matrix_aid: HHandle, matrix_bid: HHandle ) -> HHandle

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

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

HMatrix HMatrix.MultElementMatrix( HMatrix matrixBID )

Description🔗

The operator mult_element_matrixMultElementMatrix multiplies the two matrices MatrixA and MatrixB element-by-element. The matrices are defined by the matrix handles MatrixAIDmatrixAIDmatrix_aid and MatrixBIDmatrixBIDmatrix_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 MatrixMultIDmatrixMultIDmatrix_mult_id of the matrix MatrixMult. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixGetFullMatrix. The formula for the calculation of the result is:

\[\begin{eqnarray*} \texttt{MatrixMult}_{ij} \quad = \quad \texttt{MatrixA}_{ij} \quad \cdot \quad \texttt{MatrixB}_{ij}. \end{eqnarray*}\]

Example:

\[\begin{eqnarray*} \texttt{MatrixA} = \left[ \begin{array}{rrr} 4.0 & 8.0 & 0.0 \\ -6.0 & 7.0 & 2.0 \\ -9.0 & 4.0 & 1.0 \end{array} \right] \qquad \texttt{MatrixB} = \left[ \begin{array}{rrr} 2.0 & 8.0 & -3.0 \\ -4.0 & -1.0 & 4.0 \\ -2.0 & -4.0 & 2.0 \end{array} \right] \end{eqnarray*}\]
\[\begin{eqnarray*} \to \qquad \texttt{MatrixMult} = \left[ \begin{array}{rrr} 8.0 & 64.0 & 0.0 \\ 24.0 & -7.0 & 8.0 \\ 18.0 & -16.0 & 2.0 \end{array} \right] \end{eqnarray*}\]

Execution information🔗

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🔗

MatrixAIDmatrixAIDmatrix_aid (input_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix A.

MatrixBIDmatrixBIDmatrix_bid (input_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix B.

MatrixMultIDmatrixMultIDmatrix_mult_id (output_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle with the multiplied values of the input matrices.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Possible successors

get_full_matrixGetFullMatrix, get_value_matrixGetValueMatrix

Alternatives

mult_element_matrix_modMultElementMatrixMod

See also

div_element_matrixDivElementMatrix, div_element_matrix_modDivElementMatrixMod, scale_matrixScaleMatrix, scale_matrix_modScaleMatrixMod

Module🔗

Foundation