Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::PastixLLT< _MatrixType, Options > Class Template Reference

Detailed Description

template<typename _MatrixType, int Options>
class Eigen::PastixLLT< _MatrixType, Options >

A sparse direct supernodal Cholesky (LLT) factorization and solver based on the PaStiX library.

This class is used to solve the linear systems A.X = B via a LL^T supernodal Cholesky factorization available in the PaStiX library. The matrix A should be symmetric and positive definite WARNING Selfadjoint complex matrices are not supported in the current version of PaStiX The vectors or matrices X and B can be either dense or sparse

Template Parameters
MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
UpLoThe part of the matrix to use : Lower or Upper. The default is Lower as required by PaStiX

This class follows the sparse solver concept .

See Also
Sparse solver concept, class SimplicialLLT

Inherits Eigen::PastixBase< Derived >.

Public Member Functions

void analyzePattern (const MatrixType &matrix)
 
void compute (const MatrixType &matrix)
 
void factorize (const MatrixType &matrix)
 
- Public Member Functions inherited from Eigen::PastixBase< Derived >
Array< double, DPARM_SIZE, 1 > & dparm ()
 
double & dparm (int idxparam)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
Array< StorageIndex,
IPARM_SIZE, 1 > & 
iparm ()
 
int & iparm (int idxparam)
 
- Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
template<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
 
template<typename Rhs >
const Solve< Derived, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from Eigen::PastixBase< Derived >
void init ()
 

Member Function Documentation

template<typename _MatrixType , int Options>
void Eigen::PastixLLT< _MatrixType, Options >::analyzePattern ( const MatrixType &  matrix)
inline

Compute the LL^T symbolic factorization of matrix using its sparsity pattern The result of this operation can be used with successive matrices having the same pattern as matrix

See Also
factorize()
template<typename _MatrixType , int Options>
void Eigen::PastixLLT< _MatrixType, Options >::compute ( const MatrixType &  matrix)
inline

Compute the L factor of the LL^T supernodal factorization of matrix

See Also
analyzePattern() factorize()
template<typename _MatrixType , int Options>
void Eigen::PastixLLT< _MatrixType, Options >::factorize ( const MatrixType &  matrix)
inline

Compute the LL^T supernodal numerical factorization of matrix

See Also
analyzePattern()

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