Eigen::CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference

The base class for the direct Cholesky factorization of Cholmod. More...

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodBase< _MatrixType, _UpLo, Derived >:

Public Types
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
	CholmodBase (const MatrixType &matrix)
StorageIndex	cols () const
StorageIndex	rows () const
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
Derived &	compute (const MatrixType &matrix)
void	analyzePattern (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
cholmod_common &	cholmod ()
template<typename Rhs , typename Dest >
void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
template<typename RhsDerived , typename DestDerived >
void	_solve_impl (const SparseMatrixBase< RhsDerived > &b, SparseMatrixBase< DestDerived > &dest) const
Derived &	setShift (const RealScalar &offset)
Scalar	determinant () const
Scalar	logDeterminant () const
template<typename Stream >
void	dumpMemory (Stream &)
Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	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 Types
typedef SparseSolverBase< Derived >	Base

Protected Member Functions
Derived &	derived ()
const Derived &	derived () const

Protected Attributes
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, typename Derived>
class Eigen::CholmodBase< _MatrixType, _UpLo, Derived >

The base class for the direct Cholesky factorization of Cholmod.

See also

class CholmodSupernodalLLT, class CholmodSimplicialLDLT, class CholmodSimplicialLLT

Member Function Documentation

analyzePattern()

template<typename _MatrixType , int _UpLo, typename Derived >

void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::analyzePattern ( const MatrixType &  matrix )

inline

Performs a symbolic decomposition on the sparsity pattern of matrix.

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

See also

factorize()

cholmod()

template<typename _MatrixType , int _UpLo, typename Derived >

cholmod_common& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::cholmod ( )

inline

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.

compute()

template<typename _MatrixType , int _UpLo, typename Derived >

Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

determinant()

template<typename _MatrixType , int _UpLo, typename Derived >

Scalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::determinant ( ) const

inline

Returns

the determinant of the underlying matrix from the current factorization

factorize()

template<typename _MatrixType , int _UpLo, typename Derived >

void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::factorize ( const MatrixType &  matrix )

inline

Performs a numeric decomposition of matrix

The given matrix must have the same sparsity pattern as the matrix on which the symbolic decomposition has been performed.

See also

analyzePattern()

info()

template<typename _MatrixType , int _UpLo, typename Derived >

ComputationInfo Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::info ( ) const

inline

Reports whether previous computation was successful.

Returns

Success if computation was successful, NumericalIssue if the matrix.appears to be negative.

logDeterminant()

template<typename _MatrixType , int _UpLo, typename Derived >

Scalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::logDeterminant ( ) const

inline

Returns

the log determinant of the underlying matrix from the current factorization

setShift()

template<typename _MatrixType , int _UpLo, typename Derived >

Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::setShift ( const RealScalar &  offset )

inline

Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.

During the numerical factorization, an offset term is added to the diagonal coefficients:
d_ii = offset + d_ii

The default is offset=0.

Returns

a reference to *this.

---

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

• CholmodSupport.h