Eigen  3.3.4
Eigen::CholmodDecomposition< _MatrixType, _UpLo > Class Template Reference

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
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
_UpLothe triangular part that will be used for the computations. It can be Lower or Upper. Default is Lower.

This class follows the sparse solver concept .

This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non compressed.

Only double precision real and complex scalar types are supported by Cholmod.
See also
Sparse solver concept
+ Inheritance diagram for Eigen::CholmodDecomposition< _MatrixType, _UpLo >:

Additional Inherited Members

- Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodDecomposition< _MatrixType, _UpLo > >
void analyzePattern (const MatrixType &matrix)
cholmod_common & cholmod ()
CholmodDecomposition< _MatrixType, _UpLo > & 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
CholmodDecomposition< _MatrixType, _UpLo > & setShift (const RealScalar &offset)
- Public Member Functions inherited from Eigen::SparseSolverBase< CholmodDecomposition< _MatrixType, _UpLo > >
const Solve< CholmodDecomposition< _MatrixType, _UpLo >, Rhs > solve (const MatrixBase< Rhs > &b) const
const Solve< CholmodDecomposition< _MatrixType, _UpLo >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 SparseSolverBase ()

The documentation for this class was generated from the following file: