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, _UpLo, CholmodSupernodalLLT< _MatrixType, _UpLo > >
enum

typedef MatrixType	CholMatrixType

typedef MatrixType::Index	Index

typedef _MatrixType	MatrixType

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::Scalar	Scalar

Public Member Functions
	CholmodSupernodalLLT ()

	CholmodSupernodalLLT (const MatrixType &matrix)

	~CholmodSupernodalLLT ()

Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodSupernodalLLT< _MatrixType, _UpLo > >
void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

void	_solve (const SparseMatrix< RhsScalar, RhsOptions, RhsIndex > &b, SparseMatrix< DestScalar, DestOptions, DestIndex > &dest) const

void	analyzePattern (const MatrixType &matrix)

cholmod_common &	cholmod ()

	CholmodBase ()

	CholmodBase (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 &)

void	factorize (const MatrixType &matrix)

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

Index	rows () const

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

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

	~CholmodBase ()

Protected Member Functions
void	init ()

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

Additional Inherited Members
Protected Attributes inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodSupernodalLLT< _MatrixType, _UpLo > >
int	m_analysisIsOk

cholmod_common	m_cholmod

cholmod_factor *	m_cholmodFactor

int	m_factorizationIsOk

ComputationInfo	m_info

bool	m_isInitialized

RealScalar	m_shiftOffset [2]

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

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

See also: TutorialSparseDirectSolvers

Definition at line 473 of file CholmodSupport.h.