ClassesClassesClassesClasses | | | | Operators

abs_matrixabs_matrixAbsMatrixabs_matrixAbsMatrixAbsMatrix (Operator)

Name

abs_matrixabs_matrixAbsMatrixabs_matrixAbsMatrixAbsMatrix — Compute the absolute values of the elements of a matrix.

Signature

abs_matrix( : : MatrixID : MatrixAbsID)

Herror abs_matrix(const Hlong MatrixID, Hlong* MatrixAbsID)

Herror T_abs_matrix(const Htuple MatrixID, Htuple* MatrixAbsID)

Herror abs_matrix(const HTuple& MatrixID, Hlong* MatrixAbsID)

HMatrix HMatrix::AbsMatrix() const

void AbsMatrix(const HTuple& MatrixID, HTuple* MatrixAbsID)

HMatrix HMatrix::AbsMatrix() const

void HOperatorSetX.AbsMatrix(
[in] VARIANT MatrixID, [out] VARIANT* MatrixAbsID)

IHMatrixX* HMatrixX.AbsMatrix()

static void HOperatorSet.AbsMatrix(HTuple matrixID, out HTuple matrixAbsID)

HMatrix HMatrix.AbsMatrix()

Description

The operator abs_matrixabs_matrixAbsMatrixabs_matrixAbsMatrixAbsMatrix computes the absolute values of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixAbsMatrixAbsMatrixAbsMatrixAbsMatrixAbsmatrixAbs is generated with the result. The operator returns the matrix handle MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsID of the matrix MatrixAbsMatrixAbsMatrixAbsMatrixAbsMatrixAbsmatrixAbs. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

Example:

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix.

MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsID (output_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle with the absolute values of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Alternatives

abs_matrix_modabs_matrix_modAbsMatrixModabs_matrix_modAbsMatrixModAbsMatrixMod

Module

Foundation


ClassesClassesClassesClasses | | | | Operators