Eigen::CholmodDecomposition< MatrixType_, UpLo_ > Class Template Reference

#include <Eigen/src/CholmodSupport/CholmodSupport.h>

Detailed Description

template<typename MatrixType_, int UpLo_ = Lower>
class Eigen::CholmodDecomposition< MatrixType_, UpLo_ >

A general 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 selfadjoint and positive definite. The vectors or matrices X and B can be either dense or sparse.

This variant permits to change the underlying Cholesky method at runtime. On the other hand, it does not provide access to the result of the factorization. The default is to let Cholmod automatically choose between a simplicial and supernodal factorization.

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 follows the sparse solver concept .

This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non compressed.

Warning

Only double precision real and complex scalar types are supported by Cholmod.

See also

Sparse solver concept

Inheritance diagram for Eigen::CholmodDecomposition< MatrixType_, UpLo_ >:

Additional Inherited Members
Public Member Functions inherited from Eigen::CholmodBase< MatrixType_, Lower, CholmodDecomposition< MatrixType_, Lower > >
void	analyzePattern (const MatrixType &matrix)
cholmod_common &	cholmod ()
CholmodDecomposition< MatrixType_, Lower > &	compute (const MatrixType &matrix)
Scalar	determinant () const
void	factorize (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
Scalar	logDeterminant () const
CholmodDecomposition< MatrixType_, Lower > &	setShift (const RealScalar &offset)
Public Member Functions inherited from Eigen::SparseSolverBase< CholmodDecomposition< MatrixType_, Lower > >
const Solve< CholmodDecomposition< MatrixType_, Lower >, Rhs >	solve (const MatrixBase< Rhs > &b) const
const Solve< CholmodDecomposition< MatrixType_, Lower >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
	SparseSolverBase ()

---

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

• /usr/local/google/home/cantonios/dev/eigen/Eigen/src/CholmodSupport/CholmodSupport.h