CholmodDecomposition< _MatrixType, _UpLo > Class Template Reference

A Cholesky factorization and solver based on Cholmod. More...

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 ()
	CholmodDecomposition ()
	CholmodDecomposition (const MatrixType &matrix)
Index	cols () const
void	compute (const MatrixType &matrix)
template<typename Stream >
void	dumpMemory (Stream &s)
void	factorize (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
Index	rows () const
void	setMode (CholmodMode mode)
template<typename Rhs >
const internal::solve_retval < CholmodDecomposition, Rhs >	solve (const MatrixBase< Rhs > &b) const
template<typename Rhs >
const internal::sparse_solve_retval < CholmodDecomposition, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
	~CholmodDecomposition ()
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 = Lower>
class Eigen::CholmodDecomposition< _MatrixType, _UpLo >

A Cholesky factorization and solver based on Cholmod.

This class allows to solve for A.X = B sparse linear problems via a LL^T or LDL^T Cholesky factorization using the Cholmod library. 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; isCompressed() or unisCompressed().

See also:

Solving linear problems

---

Member Typedef Documentation

typedef MatrixType CholMatrixType

typedef MatrixType::Index Index

typedef _MatrixType MatrixType

typedef MatrixType::RealScalar RealScalar

typedef MatrixType::Scalar Scalar

---

Member Enumeration Documentation

anonymous enum

Enumerator:

UpLo

---

Constructor & Destructor Documentation

CholmodDecomposition

(

)

[inline]

CholmodDecomposition

(

const MatrixType &

matrix

)

[inline]

~CholmodDecomposition

(

)

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

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]

void compute

(

const MatrixType &

matrix

)

[inline]

Computes the sparse Cholesky decomposition of matrix

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

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]

void setMode

(

CholmodMode

mode

)

[inline]

const internal::solve_retval<CholmodDecomposition, 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<CholmodDecomposition, 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]

cholmod_common m_cholmod [mutable, protected]

cholmod_factor* m_cholmodFactor [protected]

int m_factorizationIsOk [protected]

ComputationInfo m_info [mutable, protected]

bool m_isInitialized [protected]

---

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