Eigen  3.4.0 (git rev e3e74001f7c4bf95f0dde572e8a08c5b2918a3ab)
List of all members | Public Member Functions
Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering > Class Template Reference
Sparse linear algebra » Reference » SparseCholesky module

Detailed Description

template<typename _MatrixType, int _UpLo, typename _Ordering>
class Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >

Deprecated:
use SimplicialLDLT or class SimplicialLLT
See also
class SimplicialLDLT, class SimplicialLLT
+ Inheritance diagram for Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >:

Public Member Functions

void analyzePattern (const MatrixType &a)
 
SimplicialCholesky & compute (const MatrixType &matrix)
 
void factorize (const MatrixType &a)
 
- Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > & permutationP () const
 
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > & permutationPinv () const
 
SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & setShift (const RealScalar &offset, const RealScalar &scale=1)
 
 SimplicialCholeskyBase ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
void compute (const MatrixType &matrix)
 

Member Function Documentation

◆ analyzePattern()

template<typename _MatrixType , int _UpLo, typename _Ordering >
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::analyzePattern ( const MatrixType &  a)
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()

◆ compute()

template<typename _MatrixType , int _UpLo, typename _Ordering >
SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::compute ( const MatrixType &  matrix)
inline

Computes the sparse Cholesky decomposition of matrix

◆ factorize()

template<typename _MatrixType , int _UpLo, typename _Ordering >
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::factorize ( const MatrixType &  a)
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()
The documentation for this class was generated from the following file: