div_element_matrix_modT_div_element_matrix_modDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod (Operator)

Name

div_element_matrix_modT_div_element_matrix_modDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod — Divide matrices element-by-element.

Signature

div_element_matrix_mod( : : MatrixAID, MatrixBID : )

Herror T_div_element_matrix_mod(const Htuple MatrixAID, const Htuple MatrixBID)

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

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

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

void HMatrix.DivElementMatrixMod(HMatrix matrixBID)

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

Description

The operator div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod divides the two matrices MatrixA and MatrixB element-by-element. The matrices are given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAIDmatrix_aid and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBIDmatrix_bid. It is required that both input matrices 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:

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 div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod returns the value 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

div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrixdiv_element_matrix

See also

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrixmult_element_matrix, mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixModmult_element_matrix_mod, scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrixscale_matrix, scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixModscale_matrix_mod

Module

Foundation