sqrt_matrixT_sqrt_matrixSqrtMatrixSqrtMatrix (Operator)

Name

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

Signature

sqrt_matrix( : : MatrixID : MatrixSqrtID)

Herror T_sqrt_matrix(const Htuple MatrixID, Htuple* MatrixSqrtID)

void SqrtMatrix(const HTuple& MatrixID, HTuple* MatrixSqrtID)

HMatrix HMatrix::SqrtMatrix() const

static void HOperatorSet.SqrtMatrix(HTuple matrixID, out HTuple matrixSqrtID)

HMatrix HMatrix.SqrtMatrix()

Description

The operator sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix computes the square root values of all elements of the input MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrt is generated with the result. The operator returns the matrix handle MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtID of the matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrt. 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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtID (output_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the square root values of the input matrix.

Result

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

See also

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix, pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod

Module

Foundation