![]() |
Eigen
3.3.3
|
A sparse LU factorization and solver based on UmfPack.
This class allows to solve for A.X = B sparse linear problems via a LU factorization using the UmfPack library. The sparse matrix A must be squared and full rank. The vectors or matrices X and B can be either dense or sparse.
_MatrixType | the type of the sparse matrix A, it must be a SparseMatrix<> |
This class follows the sparse solver concept .
Public Member Functions | |
template<typename InputMatrixType > | |
void | analyzePattern (const InputMatrixType &matrix) |
template<typename InputMatrixType > | |
void | compute (const InputMatrixType &matrix) |
template<typename InputMatrixType > | |
void | factorize (const InputMatrixType &matrix) |
ComputationInfo | info () const |
Reports whether previous computation was successful. | |
const UmfpackControl & | umfpackControl () const |
UmfpackControl & | umfpackControl () |
int | umfpackFactorizeReturncode () const |
void Eigen::UmfPackLU< _MatrixType >::analyzePattern | ( | const InputMatrixType & | matrix | ) | [inline] |
Performs a symbolic decomposition on the sparcity of matrix.
This function is particularly useful when solving for several problems having the same structure.
void Eigen::UmfPackLU< _MatrixType >::compute | ( | const InputMatrixType & | matrix | ) | [inline] |
Computes the sparse Cholesky decomposition of matrix Note that the matrix should be column-major, and in compressed format for best performance.
void Eigen::UmfPackLU< _MatrixType >::factorize | ( | const InputMatrixType & | matrix | ) | [inline] |
Performs a numeric decomposition of matrix
The given matrix must has the same sparcity than the matrix on which the pattern anylysis has been performed.
ComputationInfo Eigen::UmfPackLU< _MatrixType >::info | ( | ) | const [inline] |
Reports whether previous computation was successful.
Success
if computation was succesful, NumericalIssue
if the matrix.appears to be negative. const UmfpackControl& Eigen::UmfPackLU< _MatrixType >::umfpackControl | ( | ) | const [inline] |
Provides access to the control settings array used by UmfPack.
If this array contains NaN's, the default values are used.
See UMFPACK documentation for details.
UmfpackControl& Eigen::UmfPackLU< _MatrixType >::umfpackControl | ( | ) | [inline] |
Provides access to the control settings array used by UmfPack.
If this array contains NaN's, the default values are used.
See UMFPACK documentation for details.
int Eigen::UmfPackLU< _MatrixType >::umfpackFactorizeReturncode | ( | ) | const [inline] |
Provides the return status code returned by UmfPack during the numeric factorization.