CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference

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

#include <CholmodSupport.h>

Inherits noncopyable.

List of all members.

Public Types
enum	{ UpLo }
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_common &	cholmod ()
	CholmodBase ()
	CholmodBase (const MatrixType &matrix)
Index	cols () const
Derived &	compute (const MatrixType &matrix)
Derived &	derived ()
const Derived &	derived () const
template<typename Stream >
void	dumpMemory (Stream &s)
void	factorize (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
Index	rows () const
template<typename Rhs >
const internal::solve_retval < CholmodBase, Rhs >	solve (const MatrixBase< Rhs > &b) const
template<typename Rhs >
const internal::sparse_solve_retval < CholmodBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
	~CholmodBase ()

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, 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 Typedef Documentation

typedef MatrixType CholMatrixType

typedef MatrixType::Index Index

typedef _MatrixType MatrixType

Reimplemented in CholmodDecomposition< _MatrixType, _UpLo >, CholmodSupernodalLLT< _MatrixType, _UpLo >, CholmodSimplicialLDLT< _MatrixType, _UpLo >, and CholmodSimplicialLLT< _MatrixType, _UpLo >.

typedef MatrixType::RealScalar RealScalar

typedef MatrixType::Scalar Scalar

---

Member Enumeration Documentation

anonymous enum

Enumerator:

UpLo

---

Constructor & Destructor Documentation

CholmodBase ( )

inline

CholmodBase ( const MatrixType &  matrix )

inline

~CholmodBase ( )

inline

---

Member Function Documentation

void analyzePattern ( const MatrixType &  matrix )

inline

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

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute().

cholmod_common& 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.

Index cols ( ) const

inline

Derived& compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::CholmodBase().

Derived& derived ( )

inline

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute().

const Derived& derived ( ) const

inline

void dumpMemory ( Stream &  s )

inline

void factorize ( const MatrixType &  matrix )

inline

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

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute().

ComputationInfo info ( ) const

inline

Reports whether previous computation was successful.

Returns:

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

Index rows ( ) const

inline

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::solve().

const internal::solve_retval<CholmodBase, Rhs> solve ( const MatrixBase< Rhs > &  b ) const

inline

Returns:

the solution x of using the current decomposition of A.

See also:

compute()

const internal::sparse_solve_retval<CholmodBase, Rhs> solve ( const SparseMatrixBase< Rhs > &  b ) const

inline

Returns:

the solution x of using the current decomposition of A.

See also:

compute()

---

Member Data Documentation

int m_analysisIsOk

protected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::factorize().

cholmod_common m_cholmod

mutableprotected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::cholmod(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::CholmodBase(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::factorize(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::~CholmodBase().

cholmod_factor* m_cholmodFactor

protected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::cols(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::factorize(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::rows(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::~CholmodBase().

int m_factorizationIsOk

protected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::factorize().

ComputationInfo m_info

mutableprotected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::factorize(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::info().

bool m_isInitialized

protected

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::analyzePattern(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::info(), and CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::solve().

---

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

• CholmodSupport.h