Eigen  3.4.90 (git rev 67eeba6e720c5745abc77ae6c92ce0a44aa7b7ae)
List of all members
Eigen::CholmodSupernodalLLT< MatrixType_, UpLo_ > Class Template Reference
Sparse linear algebra » Reference » Support modules » CholmodSupport module

Detailed Description

template<typename MatrixType_, int UpLo_ = Lower>
class Eigen::CholmodSupernodalLLT< MatrixType_, UpLo_ >

A supernodal Cholesky (LLT) factorization and solver based on Cholmod.

This class allows to solve for A.X = B sparse linear problems via a supernodal LL^T Cholesky factorization using the Cholmod library. This supernodal variant performs best on dense enough problems, e.g., 3D FEM, or very high order 2D FEM. The sparse matrix A must be selfadjoint and positive definite. The vectors or matrices X and B can be either dense or sparse.

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.

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.

Warning
Only double precision real and complex scalar types are supported by Cholmod.
See also
Sparse solver concept
+ Inheritance diagram for Eigen::CholmodSupernodalLLT< MatrixType_, UpLo_ >:

Additional Inherited Members

- Public Member Functions inherited from Eigen::CholmodBase< MatrixType_, Lower, CholmodSupernodalLLT< MatrixType_, Lower > >
void analyzePattern (const MatrixType &matrix)
 
cholmod_common & cholmod ()
 
CholmodSupernodalLLT< MatrixType_, Lower > & 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
 
CholmodSupernodalLLT< MatrixType_, Lower > & 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 ()
 
The documentation for this class was generated from the following file: