ClassesClassesClassesClasses | | | | Operators

sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod (Operator)

Name

sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod — Compute the square root values of the elements of a matrix.

Signature

sqrt_matrix_mod( : : MatrixID : )

Herror sqrt_matrix_mod(const Hlong MatrixID)

Herror T_sqrt_matrix_mod(const Htuple MatrixID)

Herror sqrt_matrix_mod(const HTuple& MatrixID)

void HMatrix::SqrtMatrixMod() const

void SqrtMatrixMod(const HTuple& MatrixID)

void HMatrix::SqrtMatrixMod() const

void HOperatorSetX.SqrtMatrixMod([in] VARIANT MatrixID)

void HMatrixX.SqrtMatrixMod()

static void HOperatorSet.SqrtMatrixMod(HTuple matrixID)

void HMatrix.SqrtMatrixMod()

Description

The operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod computes the square root values of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The input matrix is overwritten with the result. 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

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

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

Matrix handle of the input matrix.

Result

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

sqrt_matrixsqrt_matrixSqrtMatrixsqrt_matrixSqrtMatrixSqrtMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators