Eigen  3.2.7
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members | Public Member Functions
CholmodDecomposition< _MatrixType, _UpLo > Class Template Reference
CholmodSupport module

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
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
_UpLothe 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; compressed or non compressed.

See Also
Sparse solvers
+ Inheritance diagram for CholmodDecomposition< _MatrixType, _UpLo >:

Public Member Functions

void analyzePattern (const MatrixType &matrix)
 
cholmod_common & cholmod ()
 
CholmodDecomposition
< _MatrixType, _UpLo > & 		compute (const MatrixType &matrix)
 
void factorize (const MatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
CholmodDecomposition
< _MatrixType, _UpLo > & 		setShift (const RealScalar &offset)
 
const internal::solve_retval
< CholmodBase, Rhs > 		solve (const MatrixBase< Rhs > &b) const
 
const
internal::sparse_solve_retval
< CholmodBase, Rhs > 		solve (const SparseMatrixBase< Rhs > &b) const
 

Member Function Documentation

void analyzePattern ( const MatrixType &  matrix)
inlineinherited

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_common& cholmod ( )
inlineinherited

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.

CholmodDecomposition< _MatrixType, _UpLo > & compute ( const MatrixType &  matrix)
inlineinherited

Computes the sparse Cholesky decomposition of matrix

void factorize ( const MatrixType &  matrix)
inlineinherited

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()
ComputationInfo info ( ) const
inlineinherited

Reports whether previous computation was successful.

Returns
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.
CholmodDecomposition< _MatrixType, _UpLo > & setShift ( const RealScalar &  offset)
inlineinherited

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.
const internal::solve_retval<CholmodBase, Rhs> solve ( const MatrixBase< Rhs > &  b) const
inlineinherited
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See Also
compute()
const internal::sparse_solve_retval<CholmodBase, Rhs> solve ( const SparseMatrixBase< Rhs > &  b) const
inlineinherited
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See Also
compute()
The documentation for this class was generated from the following file: