W3cubDocs
/Eigen3Eigen::UmfPackLU
template<typename _MatrixType>
class Eigen::UmfPackLU< _MatrixType >
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.
- Warning
- The input matrix A should be in a compressed and column-major form. Otherwise an expensive copy will be made. You can call the inexpensive makeCompressed() to get a compressed matrix.
- Template Parameters
-
_MatrixType the type of the sparse matrix A, it must be a SparseMatrix<>
This class follows the sparse solver concept .
- See also
- Sparse solver concept, class SparseLU
| 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. More... |
|
| void | printUmfpackControl () |
| void | printUmfpackInfo () |
| void | printUmfpackStatus () |
| UmfpackControl & | umfpackControl () |
| const UmfpackControl & | umfpackControl () const |
| int | umfpackFactorizeReturncode () const |
 Public Member Functions inherited from Eigen::SparseSolverBase< UmfPackLU< _MatrixType > >
| |
| const Solve< UmfPackLU< _MatrixType >, Rhs > | solve (const MatrixBase< Rhs > &b) const |
| const Solve< UmfPackLU< _MatrixType >, Rhs > | solve (const SparseMatrixBase< Rhs > &b) const |
| SparseSolverBase () | |
analyzePattern()
| inline |
Performs a symbolic decomposition on the sparcity of matrix.
This function is particularly useful when solving for several problems having the same structure.
- See also
- factorize(), compute()
compute()
| inline |
Computes the sparse Cholesky decomposition of matrix Note that the matrix should be column-major, and in compressed format for best performance.
- See also
- SparseMatrix::makeCompressed().
factorize()
| 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.
- See also
- analyzePattern(), compute()
info()
| inline |
Reports whether previous computation was successful.
- Returns
-
Successif computation was successful,NumericalIssueif the matrix.appears to be negative.
printUmfpackControl()
| inline |
Prints the current UmfPack control settings.
- See also
- umfpackControl()
printUmfpackInfo()
| inline |
Prints statistics collected by UmfPack.
- See also
- analyzePattern(), compute()
printUmfpackStatus()
| inline |
Prints the status of the previous factorization operation performed by UmfPack (symbolic or numerical factorization).
- See also
- analyzePattern(), compute()
umfpackControl() [1/2]
| 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() [2/2]
| 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.
umfpackFactorizeReturncode()
| inline |
Provides the return status code returned by UmfPack during the numeric factorization.
- See also
- factorize(), compute()
The documentation for this class was generated from the following file:
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1UmfPackLU.html