Public Types | Public Member Functions | Protected Member Functions | List of all members
Eigen::PastixLLT< _MatrixType, _UpLo > Class Template Reference

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

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixLLT< _MatrixType, _UpLo >:
Inheritance graph
[legend]

Public Types

enum  { UpLo = _UpLo }
 
typedef PastixBase< PastixLLT< MatrixType, _UpLo > > Base
 
typedef Base::ColSpMatrix ColSpMatrix
 
typedef _MatrixType MatrixType
 
- Public Types inherited from Eigen::PastixBase< PastixLLT< _MatrixType, _UpLo > >
enum  
 
typedef internal::pastix_traits< PastixLLT< _MatrixType, _UpLo > >::MatrixType _MatrixType
 
typedef SparseMatrix< Scalar, ColMajor > ColSpMatrix
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 
typedef Matrix< Scalar, Dynamic, 1 > Vector
 

Public Member Functions

void analyzePattern (const MatrixType &matrix)
 
void compute (const MatrixType &matrix)
 
void factorize (const MatrixType &matrix)
 
 PastixLLT ()
 
 PastixLLT (const MatrixType &matrix)
 
- Public Member Functions inherited from Eigen::PastixBase< PastixLLT< _MatrixType, _UpLo > >
bool _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const
 
Index cols () const
 
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 ()
 
intiparm (int idxparam)
 
 PastixBase ()
 
Index rows () const
 
 ~PastixBase ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< PastixLLT< _MatrixType, _UpLo > >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
PastixLLT< _MatrixType, _UpLo > & derived ()
 
const PastixLLT< _MatrixType, _UpLo > & derived () const
 
const Solve< PastixLLT< _MatrixType, _UpLo >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< PastixLLT< _MatrixType, _UpLo >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Member Functions

void grabMatrix (const MatrixType &matrix, ColSpMatrix &out)
 
void init ()
 
- Protected Member Functions inherited from Eigen::PastixBase< PastixLLT< _MatrixType, _UpLo > >
void analyzePattern (ColSpMatrix &mat)
 
void clean ()
 
void compute (ColSpMatrix &mat)
 
void factorize (ColSpMatrix &mat)
 
void init ()
 

Additional Inherited Members

- Protected Types inherited from Eigen::PastixBase< PastixLLT< _MatrixType, _UpLo > >
typedef SparseSolverBase< PastixLLT< _MatrixType, _UpLo > > Base
 
- Protected Attributes inherited from Eigen::PastixBase< PastixLLT< _MatrixType, _UpLo > >
int m_analysisIsOk
 
int m_comm
 
Array< double, DPARM_SIZE, 1 > m_dparm
 
int m_factorizationIsOk
 
ComputationInfo m_info
 
int m_initisOk
 
Matrix< StorageIndex, Dynamic, 1 > m_invp
 
Array< int, IPARM_SIZE, 1 > m_iparm
 
pastix_data_t * m_pastixdata
 
Matrix< StorageIndex, Dynamic, 1 > m_perm
 
int m_size
 
- Protected Attributes inherited from Eigen::SparseSolverBase< PastixLLT< _MatrixType, _UpLo > >
bool m_isInitialized
 

Detailed Description

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

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
See also
Sparse solver concept, class SimplicialLLT

Definition at line 32 of file PaStiXSupport.h.

Member Typedef Documentation

◆ Base

template<typename _MatrixType, int _UpLo>
typedef PastixBase<PastixLLT<MatrixType, _UpLo> > Eigen::PastixLLT< _MatrixType, _UpLo >::Base

Definition at line 528 of file PaStiXSupport.h.

◆ ColSpMatrix

template<typename _MatrixType, int _UpLo>
typedef Base::ColSpMatrix Eigen::PastixLLT< _MatrixType, _UpLo >::ColSpMatrix

Definition at line 529 of file PaStiXSupport.h.

◆ MatrixType

template<typename _MatrixType, int _UpLo>
typedef _MatrixType Eigen::PastixLLT< _MatrixType, _UpLo >::MatrixType

Definition at line 527 of file PaStiXSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType, int _UpLo>
anonymous enum
Enumerator
UpLo 

Definition at line 532 of file PaStiXSupport.h.

Constructor & Destructor Documentation

◆ PastixLLT() [1/2]

template<typename _MatrixType, int _UpLo>
Eigen::PastixLLT< _MatrixType, _UpLo >::PastixLLT ( )
inline

Definition at line 533 of file PaStiXSupport.h.

◆ PastixLLT() [2/2]

template<typename _MatrixType, int _UpLo>
Eigen::PastixLLT< _MatrixType, _UpLo >::PastixLLT ( const MatrixType matrix)
inlineexplicit

Definition at line 538 of file PaStiXSupport.h.

Member Function Documentation

◆ analyzePattern()

template<typename _MatrixType, int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::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()

Definition at line 558 of file PaStiXSupport.h.

◆ compute()

template<typename _MatrixType, int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::compute ( const MatrixType matrix)
inline

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

See also
analyzePattern() factorize()

Definition at line 547 of file PaStiXSupport.h.

◆ factorize()

template<typename _MatrixType, int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::factorize ( const MatrixType matrix)
inline

Compute the LL^T supernodal numerical factorization of matrix

See also
analyzePattern()

Definition at line 567 of file PaStiXSupport.h.

◆ grabMatrix()

template<typename _MatrixType, int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::grabMatrix ( const MatrixType matrix,
ColSpMatrix out 
)
inlineprotected

Definition at line 582 of file PaStiXSupport.h.

◆ init()

template<typename _MatrixType, int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::init ( )
inlineprotected

Definition at line 576 of file PaStiXSupport.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:42:42