ClassesClasses | | Operators

div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrix (Operator)

Name

div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrix — Divide matrices element-by-element.

Signature

div_element_matrix( : : MatrixAID, MatrixBID : MatrixDivID)

Herror div_element_matrix(const Hlong MatrixAID, const Hlong MatrixBID, Hlong* MatrixDivID)

Herror T_div_element_matrix(const Htuple MatrixAID, const Htuple MatrixBID, Htuple* MatrixDivID)

void DivElementMatrix(const HTuple& MatrixAID, const HTuple& MatrixBID, HTuple* MatrixDivID)

HMatrix HMatrix::DivElementMatrix(const HMatrix& MatrixBID) const

static void HOperatorSet.DivElementMatrix(HTuple matrixAID, HTuple matrixBID, out HTuple matrixDivID)

HMatrix HMatrix.DivElementMatrix(HMatrix matrixBID)

Description

The operator div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrix divides the two matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB element-by-element. The matrices are given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. It is required that both input matrices have identical dimensions. The new created output MatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv contains the result. The operator returns the matrix handle MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID of the matrix MatrixDivMatrixDivMatrixDivMatrixDivmatrixDiv. 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

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix B.

MatrixDivIDMatrixDivIDMatrixDivIDMatrixDivIDmatrixDivID (output_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle with the divided values of input matrices.

Result

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

div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixMod

See also

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrix, mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixMod, scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrix, scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixMod

Module

Foundation


ClassesClasses | | Operators