Eigen::SimplicialCholeskyBase
template<typename Derived>
class Eigen::SimplicialCholeskyBase< Derived >
A base class for direct sparse Cholesky factorizations.
This is a base class for LL^T and LDL^T Cholesky factorizations of sparse matrices that are selfadjoint and positive definite. These factorizations allow for solving A.X = B where X and B can be either dense or sparse.
In order to reduce the fill-in, a symmetric permutation P is applied prior to the factorization such that the factorized matrix is P A P^-1.
- Template Parameters
-
| Derived |
the type of the derived class, that is the actual factorization type. |
|
| template<bool DoLDLT> |
| void |
compute (const MatrixType &matrix) |
| |
SimplicialCholeskyBase()
template<typename Derived >
compute()
template<typename Derived >
template<bool DoLDLT>
Computes the sparse Cholesky decomposition of matrix
info()
template<typename Derived >
Reports whether previous computation was successful.
- Returns
-
Success if computation was successful, NumericalIssue if the matrix.appears to be negative.
permutationP()
template<typename Derived >
permutationPinv()
template<typename Derived >
setShift()
template<typename Derived >
Sets the shift parameters that will be used to adjust the diagonal coefficients during the numerical factorization.
During the numerical factorization, the diagonal coefficients are transformed by the following linear model:
d_ii = offset + scale * d_ii
The default is the identity transformation with offset=0, and scale=1.
- Returns
- a reference to
*this.
The documentation for this class was generated from the following files:
Public Member Functions inherited from Eigen::SparseSolverBase< Derived >