Public Member Functions | List of all members
CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference

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

#include <CholmodSupport.h>

Public Member Functions

void analyzePattern (const MatrixType &matrix)
 
cholmod_common & cholmod ()
 
Derived & compute (const MatrixType &matrix)
 
void factorize (const MatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful.
 
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
 

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 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 >::compute().

◆ cholmod()

template<typename _MatrixType, int _UpLo, typename Derived>
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.

◆ compute()

template<typename _MatrixType, int _UpLo, typename Derived>
Derived & compute ( const MatrixType & matrix)
inline

Computes the sparse Cholesky decomposition of matrix

◆ factorize()

template<typename _MatrixType, int _UpLo, typename Derived>
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 >::compute().

◆ info()

template<typename _MatrixType, int _UpLo, typename Derived>
ComputationInfo info ( ) const
inline

Reports whether previous computation was successful.

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

◆ solve() [1/2]

template<typename _MatrixType, int _UpLo, typename Derived>
template<typename Rhs>
const internal::solve_retval< CholmodBase, Rhs > solve ( const MatrixBase< Rhs > & b) const
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See also
compute()

◆ solve() [2/2]

template<typename _MatrixType, int _UpLo, typename Derived>
template<typename Rhs>
const internal::sparse_solve_retval< CholmodBase, Rhs > solve ( const SparseMatrixBase< Rhs > & b) const
inline
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: