Eigen::CholmodBase
template<typename _MatrixType, int _UpLo, typename Derived>
class Eigen::CholmodBase< _MatrixType, _UpLo, Derived >
The base class for the direct Cholesky factorization of Cholmod.
- See also
- class CholmodSupernodalLLT, class CholmodSimplicialLDLT, class CholmodSimplicialLLT
| void | analyzePattern (const MatrixType &matrix) |
| cholmod_common & | cholmod () |
| Derived & | compute (const MatrixType &matrix) |
| Scalar | determinant () const |
| void | factorize (const MatrixType &matrix) |
| ComputationInfo | info () const |
| Reports whether previous computation was successful. More... |
|
| Scalar | logDeterminant () const |
| Derived & | setShift (const RealScalar &offset) |
 Public Member Functions inherited from Eigen::SparseSolverBase< Derived > |
|
| template<typename Rhs > | |
| const Solve< Derived, Rhs > | solve (const MatrixBase< Rhs > &b) const |
| template<typename Rhs > | |
| const Solve< Derived, Rhs > | solve (const SparseMatrixBase< Rhs > &b) const |
| SparseSolverBase () | |
analyzePattern()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Performs a symbolic decomposition on the sparsity pattern of matrix.
This function is particularly useful when solving for several problems having the same structure.
- See also
- factorize()
cholmod()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations. See the Cholmod user guide for details.
compute()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Computes the sparse Cholesky decomposition of matrix
determinant()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
- Returns
- the determinant of the underlying matrix from the current factorization
factorize()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Performs a numeric decomposition of matrix
The given matrix must have the same sparsity pattern as the matrix on which the symbolic decomposition has been performed.
- See also
- analyzePattern()
info()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Reports whether previous computation was successful.
- Returns
Successif computation was successful,NumericalIssueif the matrix.appears to be negative.
logDeterminant()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
- Returns
- the log determinant of the underlying matrix from the current factorization
setShift()
template<typename _MatrixType , int _UpLo, typename Derived >
|
inline |
Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.
During the numerical factorization, an offset term is added to the diagonal coefficients:
d_ii = offset + d_ii
The default is offset=0.
- Returns
-
a reference to
*this.
The documentation for this class was generated from the following file:
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1CholmodBase.html