A general Cholesky factorization and solver based on Cholmod. More...
#include <CholmodSupport.h>
Inheritance diagram for Eigen::CholmodDecomposition< _MatrixType, _UpLo >:
Public Types | |
| typedef _MatrixType | MatrixType |
 Public Types inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodDecomposition< _MatrixType, Lower > > | |
| enum | |
| enum | |
| typedef _MatrixType | MatrixType |
| typedef MatrixType::Scalar | Scalar |
| typedef MatrixType::RealScalar | RealScalar |
| typedef MatrixType | CholMatrixType |
| typedef MatrixType::StorageIndex | StorageIndex |
Public Member Functions | |
| CholmodDecomposition (const MatrixType &matrix) | |
| void | setMode (CholmodMode mode) |
| Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodDecomposition< _MatrixType, Lower > > | |
| CholmodBase (const MatrixType &matrix) | |
| StorageIndex | cols () const |
| StorageIndex | rows () const |
| ComputationInfo | info () const |
| Reports whether previous computation was successful. More... | |
| CholmodDecomposition< _MatrixType, Lower > & | compute (const MatrixType &matrix) |
| void | analyzePattern (const MatrixType &matrix) |
| void | factorize (const MatrixType &matrix) |
| cholmod_common & | cholmod () |
| void | _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const |
| void | _solve_impl (const SparseMatrixBase< RhsDerived > &b, SparseMatrixBase< DestDerived > &dest) const |
| CholmodDecomposition< _MatrixType, Lower > & | setShift (const RealScalar &offset) |
| Scalar | determinant () const |
| Scalar | logDeterminant () const |
| void | dumpMemory (Stream &) |
| Public Member Functions inherited from Eigen::SparseSolverBase< CholmodDecomposition< _MatrixType, Lower > > | |
| SparseSolverBase () | |
| CholmodDecomposition< _MatrixType, Lower > & | derived () |
| const CholmodDecomposition< _MatrixType, Lower > & | derived () const |
| const Solve< CholmodDecomposition< _MatrixType, Lower >, Rhs > | solve (const MatrixBase< Rhs > &b) const |
| const Solve< CholmodDecomposition< _MatrixType, Lower >, Rhs > | solve (const SparseMatrixBase< Rhs > &b) const |
| void | _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const |
Protected Member Functions | |
| void | init () |
| Protected Member Functions inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodDecomposition< _MatrixType, Lower > > | |
| CholmodDecomposition< _MatrixType, Lower > & | derived () |
| const CholmodDecomposition< _MatrixType, Lower > & | derived () const |
Additional Inherited Members | |
| Protected Types inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodDecomposition< _MatrixType, Lower > > | |
| typedef SparseSolverBase< CholmodDecomposition< _MatrixType, Lower > > | Base |
| Protected Attributes inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodDecomposition< _MatrixType, Lower > > | |
| cholmod_common | m_cholmod |
| cholmod_factor * | m_cholmodFactor |
| double | m_shiftOffset [2] |
| ComputationInfo | m_info |
| int | m_factorizationIsOk |
| int | m_analysisIsOk |
| bool | m_isInitialized |
| Protected Attributes inherited from Eigen::SparseSolverBase< CholmodDecomposition< _MatrixType, Lower > > | |
| bool | m_isInitialized |
Detailed Description
template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodDecomposition< _MatrixType, _UpLo >
A general Cholesky factorization and solver based on Cholmod.
This class allows to solve for A.X = B sparse linear problems via a LL^T or LDL^T Cholesky factorization using the Cholmod library. The sparse matrix A must be selfadjoint and positive definite. The vectors or matrices X and B can be either dense or sparse.
This variant permits to change the underlying Cholesky method at runtime. On the other hand, it does not provide access to the result of the factorization. The default is to let Cholmod automatically choose between a simplicial and supernodal factorization.
- Template Parameters
-
_MatrixType the type of the sparse matrix A, it must be a SparseMatrix<> _UpLo the triangular part that will be used for the computations. It can be Lower or Upper. Default is Lower.
\implsparsesolverconcept
This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non compressed.
- Warning
- Only double precision real and complex scalar types are supported by Cholmod.
- See also
- TutorialSparseSolverConcept
The documentation for this class was generated from the following file:
