A simplicial direct Cholesky (LDLT) factorization and solver based on Cholmod. More...

#include <CholmodSupport.h>

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

Public Types
typedef _MatrixType	MatrixType

Public Types inherited from Eigen::CholmodBase< _MatrixType, _UpLo, Derived >
enum	{ UpLo = _UpLo }

enum	{ ColsAtCompileTime = MatrixType::ColsAtCompileTime , MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }

typedef _MatrixType	MatrixType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType	CholMatrixType

typedef MatrixType::StorageIndex	StorageIndex

Public Member Functions
	CholmodSimplicialLDLT (const MatrixType &matrix)

Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, _UpLo, Derived >
	CholmodBase (const MatrixType &matrix)

StorageIndex	cols () const

StorageIndex	rows () const

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

Derived &	compute (const MatrixType &matrix)
	Computes the sparse Cholesky decomposition of matrix.

void	analyzePattern (const MatrixType &matrix)
	Performs a symbolic decomposition on the sparsity pattern of matrix.

void	factorize (const MatrixType &matrix)
	Performs a numeric decomposition of matrix.

cholmod_common &	cholmod ()
	Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations.

template<typename Rhs , typename Dest >
void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

template<typename RhsScalar , int RhsOptions, typename RhsIndex , typename DestScalar , int DestOptions, typename DestIndex >
void	_solve_impl (const SparseMatrix< RhsScalar, RhsOptions, RhsIndex > &b, SparseMatrix< DestScalar, DestOptions, DestIndex > &dest) const

Derived &	setShift (const RealScalar &offset)
	Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.

template<typename Stream >
void	dumpMemory (Stream &)

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

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, _UpLo, Derived >
Derived &	derived ()

const Derived &	derived () const

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

Protected Attributes inherited from Eigen::CholmodBase< _MatrixType, _UpLo, Derived >
cholmod_common	m_cholmod

cholmod_factor *	m_cholmodFactor

RealScalar	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::CholmodSimplicialLDLT< _MatrixType, _UpLo >

A simplicial direct Cholesky (LDLT) factorization and solver based on Cholmod.

This class allows to solve for A.X = B sparse linear problems via a simplicial LDL^T Cholesky factorization using the Cholmod library. This simplicial variant is equivalent to Eigen's built-in SimplicialLDLT class. Therefore, it has little practical interest. 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.

See also: TutorialSparseDirectSolvers, class CholmodSupernodalLLT, class SimplicialLDLT

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

External/Eigen/src/CholmodSupport/CholmodSupport.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description