Operator Reference

HALCON Operator Reference / Matrix / Arithmetic
ClassesClasses | | Operators

solve_matrixT_solve_matrixSolveMatrixSolveMatrixsolve_matrix (Operator)

solve_matrixT_solve_matrixSolveMatrixSolveMatrixsolve_matrix — Compute the solution of a system of equations.

Signature

Herror T_solve_matrix(const Htuple MatrixLHSID, const Htuple MatrixLHSType, const Htuple Epsilon, const Htuple MatrixRHSID, Htuple* MatrixResultID)

void SolveMatrix(const HTuple& MatrixLHSID, const HTuple& MatrixLHSType, const HTuple& Epsilon, const HTuple& MatrixRHSID, HTuple* MatrixResultID)

HMatrix HMatrix::SolveMatrix(const HString& MatrixLHSType, double Epsilon, const HMatrix& MatrixRHSID) const

HMatrix HMatrix::SolveMatrix(const char* MatrixLHSType, double Epsilon, const HMatrix& MatrixRHSID) const

HMatrix HMatrix::SolveMatrix(const wchar_t* MatrixLHSType, double Epsilon, const HMatrix& MatrixRHSID) const   ( Windows only)

def solve_matrix(matrix_lhsid: HHandle, matrix_lhstype: str, epsilon: float, matrix_rhsid: HHandle) -> HHandle

Description

The operator solve_matrixsolve_matrixSolveMatrixSolveMatrixsolve_matrix computes the solution of a system of linear equations or of a linear least squares problem. The input matrices MatrixLHS and MatrixRHS are defined by the matrix handles MatrixLHSIDMatrixLHSIDMatrixLHSIDmatrixLHSIDmatrix_lhsid and MatrixRHSIDMatrixRHSIDMatrixRHSIDmatrixRHSIDmatrix_rhsid. The number of rows of matrices MatrixLHS and MatrixRHS must be identical. The operator returns the matrix handle MatrixResultIDMatrixResultIDMatrixResultIDmatrixResultIDmatrix_result_id of the matrix MatrixResult. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix.

For linear equation systems, the equations are solved. Therefore, the matrix MatrixLHS must be a square matrix and the parameter EpsilonEpsilonEpsilonepsilonepsilon must be 0. The type of the matrix MatrixLHS can be selected via the parameter MatrixLHSTypeMatrixLHSTypeMatrixLHSTypematrixLHSTypematrix_lhstype. The following values are supported: 'general'"general""general""general""general" for general, 'symmetric'"symmetric""symmetric""symmetric""symmetric" for symmetric, 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite" for symmetric positive definite, 'tridiagonal'"tridiagonal""tridiagonal""tridiagonal""tridiagonal" for tridiagonal, '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" for permuted upper 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" for permuted lower triangular matrices.

Example:

MatrixLHSTypeMatrixLHSTypeMatrixLHSTypematrixLHSTypematrix_lhstype = 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite", EpsilonEpsilonEpsilonepsilonepsilon = 0

For linear least squares problems or if EpsilonEpsilonEpsilonepsilonepsilon is not 0, the matrix MatrixLHS need not be a square matrix. The linear least squares problem is solved using the singular value decomposition (SVD) of the matrix MatrixLHS by minimizing All singular values less than the value Epsilon the largest singular value are set to 0. For these values no internal division is done to prevent a division by zero. Also, the matrix MatrixLHS may be rank-deficient. The type of matrix must be selected via MatrixLHSTypeMatrixLHSTypeMatrixLHSTypematrixLHSTypematrix_lhstype = 'general'"general""general""general""general".

Example:

MatrixLHSTypeMatrixLHSTypeMatrixLHSTypematrixLHSTypematrix_lhstype = 'general'"general""general""general""general", EpsilonEpsilonEpsilonepsilonepsilon = 2.2204e-16

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

Attention

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

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

MatrixLHSIDMatrixLHSIDMatrixLHSIDmatrixLHSIDmatrix_lhsid (input_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix of the left hand side.

MatrixLHSTypeMatrixLHSTypeMatrixLHSTypematrixLHSTypematrix_lhstype (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

The type of the input matrix of the left hand side.

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

List of values: 'general'"general""general""general""general", '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_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite", 'symmetric'"symmetric""symmetric""symmetric""symmetric", 'tridiagonal'"tridiagonal""tridiagonal""tridiagonal""tridiagonal", 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular"

EpsilonEpsilonEpsilonepsilonepsilon (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Type of solving and limitation to set singular values to be 0.

Default: 0.0

Suggested values: 0.0, 2.2204e-16

MatrixRHSIDMatrixRHSIDMatrixRHSIDmatrixRHSIDmatrix_rhsid (input_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix of right hand side.

MatrixResultIDMatrixResultIDMatrixResultIDmatrixResultIDmatrix_result_id (output_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

New matrix handle with the solution.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

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

ClassesClasses | | Operators