Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
CholmodSupernodalLLT< _MatrixType, _UpLo > Class Template Reference

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

#include <CholmodSupport.h>

+ Inheritance diagram for CholmodSupernodalLLT< _MatrixType, _UpLo >:

List of all members.

Public Types

enum  
typedef MatrixType CholMatrixType
typedef MatrixType::Index Index
typedef _MatrixType MatrixType
typedef MatrixType::RealScalar RealScalar
typedef MatrixType::Scalar Scalar

Public Member Functions

void analyzePattern (const MatrixType &matrix)
cholmod_commoncholmod ()
 CholmodSupernodalLLT ()
 CholmodSupernodalLLT (const MatrixType &matrix)
Index cols () const
CholmodSupernodalLLT
< _MatrixType, _UpLo > & 
compute (const MatrixType &matrix)
CholmodSupernodalLLT
< _MatrixType, _UpLo > & 
derived ()
const CholmodSupernodalLLT
< _MatrixType, _UpLo > & 
derived () const
void dumpMemory (Stream &s)
void factorize (const MatrixType &matrix)
ComputationInfo info () const
 Reports whether previous computation was successful.
Index rows () const
const internal::solve_retval
< CholmodBase, Rhs > 
solve (const MatrixBase< Rhs > &b) const
const
internal::sparse_solve_retval
< CholmodBase, Rhs > 
solve (const SparseMatrixBase< Rhs > &b) const
 ~CholmodSupernodalLLT ()

Protected Member Functions

void init ()

Protected Attributes

int m_analysisIsOk
cholmod_common m_cholmod
cholmod_factor * m_cholmodFactor
int m_factorizationIsOk
ComputationInfo m_info
bool m_isInitialized

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 selfajoint and positive definite. The vectors or matrices X and B can be either dense or sparse.

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 supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non compressed.

See also:
Solving linear problems

Member Typedef Documentation

typedef MatrixType CholMatrixType [inherited]
typedef MatrixType::Index Index [inherited]
typedef _MatrixType MatrixType
typedef MatrixType::RealScalar RealScalar [inherited]
typedef MatrixType::Scalar Scalar [inherited]

Member Enumeration Documentation

anonymous enum [inherited]

Constructor & Destructor Documentation

CholmodSupernodalLLT ( ) [inline]
CholmodSupernodalLLT ( const MatrixType matrix) [inline]
~CholmodSupernodalLLT ( ) [inline]

Member Function Documentation

void analyzePattern ( const MatrixType matrix) [inline, inherited]

Performs a symbolic decomposition on the sparcity of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also:
factorize()
cholmod_common& cholmod ( ) [inline, inherited]

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.

Index cols ( void  ) const [inline, inherited]
CholmodSupernodalLLT< _MatrixType, _UpLo > & compute ( const MatrixType matrix) [inline, inherited]

Computes the sparse Cholesky decomposition of matrix

Referenced by CholmodSupernodalLLT< _MatrixType, _UpLo >::CholmodSupernodalLLT().

CholmodSupernodalLLT< _MatrixType, _UpLo > & derived ( ) [inline, inherited]
const CholmodSupernodalLLT< _MatrixType, _UpLo > & derived ( ) const [inline, inherited]
void dumpMemory ( Stream &  s) [inline, inherited]
void factorize ( const MatrixType matrix) [inline, inherited]

Performs a numeric decomposition of matrix

The given matrix must has the same sparcity than the matrix on which the symbolic decomposition has been performed.

See also:
analyzePattern()
ComputationInfo info ( ) const [inline, inherited]

Reports whether previous computation was successful.

Returns:
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.
void init ( ) [inline, protected]
Index rows ( void  ) const [inline, inherited]
const internal::solve_retval<CholmodBase, Rhs> solve ( const MatrixBase< Rhs > &  b) const [inline, inherited]
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()
const internal::sparse_solve_retval<CholmodBase, Rhs> solve ( const SparseMatrixBase< Rhs > &  b) const [inline, inherited]
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()

Member Data Documentation

int m_analysisIsOk [protected, inherited]
cholmod_common m_cholmod [mutable, protected, inherited]
cholmod_factor* m_cholmodFactor [protected, inherited]
int m_factorizationIsOk [protected, inherited]
ComputationInfo m_info [mutable, protected, inherited]
bool m_isInitialized [protected, inherited]

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