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

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodSupernodalLLT< _MatrixType, _UpLo >:

Public Types
typedef _MatrixType	MatrixType

Public Types inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodSupernodalLLT< _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
	CholmodSupernodalLLT ()

	CholmodSupernodalLLT (const MatrixType &matrix)

	~CholmodSupernodalLLT ()

Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodSupernodalLLT< _MatrixType, Lower > >
	CholmodBase ()

	CholmodBase (const MatrixType &matrix)

	~CholmodBase ()

StorageIndex	cols () const

StorageIndex	rows () const

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

CholmodSupernodalLLT< _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

CholmodSupernodalLLT< _MatrixType, Lower > &	setShift (const RealScalar &offset)

Scalar	determinant () const

Scalar	logDeterminant () const

void	dumpMemory (Stream &)

Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	SparseSolverBase ()

	~SparseSolverBase ()

Derived &	derived ()

const Derived &	derived () const

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

template<typename Rhs , typename Dest >
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, CholmodSupernodalLLT< _MatrixType, Lower > >
CholmodSupernodalLLT< _MatrixType, Lower > &	derived ()

const CholmodSupernodalLLT< _MatrixType, Lower > &	derived () const

Private Types
typedef CholmodBase< _MatrixType, _UpLo, CholmodSupernodalLLT >	Base

Private Attributes
cholmod_common	m_cholmod

Additional Inherited Members
Protected Types inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodSupernodalLLT< _MatrixType, Lower > >
typedef SparseSolverBase< CholmodSupernodalLLT< _MatrixType, Lower > >	Base

Protected Attributes inherited from Eigen::CholmodBase< _MatrixType, Lower, CholmodSupernodalLLT< _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< Derived >
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 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.

\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