ClassesClasses | | Operators

sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixMod (Operator)

Name

sqrt_matrix_modsqrt_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)

void SqrtMatrixMod(const HTuple& MatrixID)

void HMatrix::SqrtMatrixMod() const

static void HOperatorSet.SqrtMatrixMod(HTuple matrixID)

void HMatrix.SqrtMatrixMod()

Description

The operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixMod computes the square root values of all elements of the input MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

Example:

Execution Information

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix.

Result

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

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix

Module

Foundation


ClassesClasses | | Operators