invert_matrixT_invert_matrixInvertMatrixInvertMatrixinvert_matrix (Operator)

Name

invert_matrixT_invert_matrixInvertMatrixInvertMatrixinvert_matrix — Invert a matrix.

Signature

invert_matrix( : : MatrixID, MatrixType, Epsilon : MatrixInvID)

Herror T_invert_matrix(const Htuple MatrixID, const Htuple MatrixType, const Htuple Epsilon, Htuple* MatrixInvID)

void InvertMatrix(const HTuple& MatrixID, const HTuple& MatrixType, const HTuple& Epsilon, HTuple* MatrixInvID)

HMatrix HMatrix::InvertMatrix(const HString& MatrixType, double Epsilon) const

HMatrix HMatrix::InvertMatrix(const char* MatrixType, double Epsilon) const

HMatrix HMatrix::InvertMatrix(const wchar_t* MatrixType, double Epsilon) const   (Windows only)

static void HOperatorSet.InvertMatrix(HTuple matrixID, HTuple matrixType, HTuple epsilon, out HTuple matrixInvID)

HMatrix HMatrix.InvertMatrix(string matrixType, double epsilon)

def invert_matrix(matrix_id: HHandle, matrix_type: str, epsilon: float) -> HHandle

Description

The operator invert_matrixinvert_matrixInvertMatrixInvertMatrixInvertMatrixinvert_matrix computes the inverse of the Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixInv is generated with the result and the matrix handle MatrixInvIDMatrixInvIDMatrixInvIDMatrixInvIDmatrixInvIDmatrix_inv_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

For EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 0, the inverse is computed. The type of the Matrix can be selected via MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type. The following values are supported: 'general'"general""general""general""general""general" for general, 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric" for symmetric, 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite" for symmetric positive definite, 'tridiagonal'"tridiagonal""tridiagonal""tridiagonal""tridiagonal""tridiagonal" for tridiagonal, 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular" for upper triangular, 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular" for permuted upper triangular, 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular" for lower triangular, and 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular" for permuted lower triangular matrices.

Example 1:

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'general'"general""general""general""general""general", EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 0

Example 2:

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular", EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 0

Example 3:

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 0

For EpsilonEpsilonEpsilonEpsilonepsilonepsilon > 0, the pseudo inverse is computed using a singular value decomposition (SVD). During the computation, all singular values less than the value EpsilonEpsilonEpsilonEpsilonepsilonepsilon the largest singular value are set to 0. For these values no internal division is done to prevent a division by zero. If a square matrix is computed with the SVD algorithm the computation takes more time. The type of the matrix must be set to MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'general'"general""general""general""general""general".

Example:

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'general'"general""general""general""general""general", EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 2.2204e-16

Note: The relative accuracy of the floating point representation of the used data type (double) is EpsilonEpsilonEpsilonEpsilonepsilonepsilon = 2.2204e-16.

It should be also noted that in the examples there are differences in the meaning of the numbers of the output matrices: The results of the elements are per definition a certain value if the number of this value is shown as an integer number, e.g., 0 or 1. If the number is shown as a floating point number, e.g., 0.0 or 1.0, the value is computed.

Attention

For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", or 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular" the upper triangular part of the input Matrix must contain the relevant information of the matrix. The strictly lower triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular" the lower triangular part of the input Matrix must contain the relevant information of the matrix. The strictly upper triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'tridiagonal'"tridiagonal""tridiagonal""tridiagonal""tridiagonal""tridiagonal", only the main diagonal, the superdiagonal, and the subdiagonal of the input Matrix are used. The other parts of the matrix are not referenced. If the referenced part of the input Matrix is not of the specified type, an exception is raised.

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

The type of the input matrix.

Default value: 'general' "general" "general" "general" "general" "general"

List of values: 'general'"general""general""general""general""general", 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular", 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular", 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'tridiagonal'"tridiagonal""tridiagonal""tridiagonal""tridiagonal""tridiagonal", 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular"

EpsilonEpsilonEpsilonEpsilonepsilonepsilon (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Type of inversion.

Default value: 0.0

Suggested values: 0.0, 2.2204e-16

MatrixInvIDMatrixInvIDMatrixInvIDMatrixInvIDmatrixInvIDmatrix_inv_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the inverse matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

invert_matrix_modinvert_matrix_modInvertMatrixModInvertMatrixModInvertMatrixModinvert_matrix_mod

See also

transpose_matrixtranspose_matrixTransposeMatrixTransposeMatrixTransposeMatrixtranspose_matrix, transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModTransposeMatrixModtranspose_matrix_mod

References

David Poole: “Linear Algebra: A Modern Introduction”; Thomson; Belmont; 2006.
Gene H. Golub, Charles F. van Loan: “Matrix Computations”; The Johns Hopkins University Press; Baltimore and London; 1996.

Module

Foundation