Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Eigen::PastixLU< _MatrixType, IsStrSym > Class Template Reference

Interface to the PaStix solver. More...

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixLU< _MatrixType, IsStrSym >:
Inheritance graph
[legend]

Public Types

typedef PastixBase< PastixLU< MatrixType > > Base
 
typedef Base::ColSpMatrix ColSpMatrix
 
typedef _MatrixType MatrixType
 
typedef MatrixType::StorageIndex StorageIndex
 
- Public Types inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
enum  
 
typedef internal::pastix_traits< PastixLU< _MatrixType > >::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)
 
 PastixLU ()
 
 PastixLU (const MatrixType &matrix)
 
- Public Member Functions inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
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< PastixLU< _MatrixType > >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
PastixLU< _MatrixType > & derived ()
 
const PastixLU< _MatrixType > & derived () const
 
const Solve< PastixLU< _MatrixType >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< PastixLU< _MatrixType >, 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< PastixLU< _MatrixType > >
void analyzePattern (ColSpMatrix &mat)
 
void clean ()
 
void compute (ColSpMatrix &mat)
 
void factorize (ColSpMatrix &mat)
 
void init ()
 

Protected Attributes

bool m_structureIsUptodate
 
ColSpMatrix m_transposedStructure
 
- Protected Attributes inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
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< PastixLU< _MatrixType > >
bool m_isInitialized
 

Additional Inherited Members

- Protected Types inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
typedef SparseSolverBase< PastixLU< _MatrixType > > Base
 

Detailed Description

template<typename _MatrixType, bool IsStrSym>
class Eigen::PastixLU< _MatrixType, IsStrSym >

Interface to the PaStix solver.

Sparse direct LU solver based on PaStiX library.

This class is used to solve the linear systems A.X = B via the PaStix library. The matrix can be either real or complex, symmetric or not.

See also
TutorialSparseDirectSolvers

This class is used to solve the linear systems A.X = B with a supernodal LU factorization in the PaStiX library. The matrix A should be squared and nonsingular PaStiX requires that the matrix A has a symmetric structural pattern. This interface can symmetrize the input matrix otherwise. 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<>
IsStrSymIndicates if the input matrix has a symmetric pattern, default is false NOTE : Note that if the analysis and factorization phase are called separately, the input matrix will be symmetrized at each call, hence it is advised to symmetrize the matrix in a end-user program and set IsStrSym to true
See also
Sparse solver concept, class SparseLU

Definition at line 31 of file PaStiXSupport.h.

Member Typedef Documentation

◆ Base

template<typename _MatrixType, bool IsStrSym>
typedef PastixBase<PastixLU<MatrixType> > Eigen::PastixLU< _MatrixType, IsStrSym >::Base

Definition at line 416 of file PaStiXSupport.h.

◆ ColSpMatrix

template<typename _MatrixType, bool IsStrSym>
typedef Base::ColSpMatrix Eigen::PastixLU< _MatrixType, IsStrSym >::ColSpMatrix

Definition at line 417 of file PaStiXSupport.h.

◆ MatrixType

template<typename _MatrixType, bool IsStrSym>
typedef _MatrixType Eigen::PastixLU< _MatrixType, IsStrSym >::MatrixType

Definition at line 415 of file PaStiXSupport.h.

◆ StorageIndex

template<typename _MatrixType, bool IsStrSym>
typedef MatrixType::StorageIndex Eigen::PastixLU< _MatrixType, IsStrSym >::StorageIndex

Definition at line 418 of file PaStiXSupport.h.

Constructor & Destructor Documentation

◆ PastixLU() [1/2]

template<typename _MatrixType, bool IsStrSym>
Eigen::PastixLU< _MatrixType, IsStrSym >::PastixLU ( )
inline

Definition at line 421 of file PaStiXSupport.h.

◆ PastixLU() [2/2]

template<typename _MatrixType, bool IsStrSym>
Eigen::PastixLU< _MatrixType, IsStrSym >::PastixLU ( const MatrixType matrix)
inlineexplicit

Definition at line 426 of file PaStiXSupport.h.

Member Function Documentation

◆ analyzePattern()

template<typename _MatrixType, bool IsStrSym>
void Eigen::PastixLU< _MatrixType, IsStrSym >::analyzePattern ( const MatrixType matrix)
inline

Compute the LU symbolic factorization of matrix using its sparsity pattern. Several ordering methods can be used at this step. See the PaStiX user's manual. The result of this operation can be used with successive matrices having the same pattern as matrix

See also
factorize()

Definition at line 448 of file PaStiXSupport.h.

◆ compute()

template<typename _MatrixType, bool IsStrSym>
void Eigen::PastixLU< _MatrixType, IsStrSym >::compute ( const MatrixType matrix)
inline

Compute the LU supernodal factorization of matrix. iparm and dparm can be used to tune the PaStiX parameters. see the PaStiX user's manual

See also
analyzePattern() factorize()

Definition at line 436 of file PaStiXSupport.h.

◆ factorize()

template<typename _MatrixType, bool IsStrSym>
void Eigen::PastixLU< _MatrixType, IsStrSym >::factorize ( const MatrixType matrix)
inline

Compute the LU supernodal factorization of matrix WARNING The matrix matrix should have the same structural pattern as the same used in the analysis phase.

See also
analyzePattern()

Definition at line 461 of file PaStiXSupport.h.

◆ grabMatrix()

template<typename _MatrixType, bool IsStrSym>
void Eigen::PastixLU< _MatrixType, IsStrSym >::grabMatrix ( const MatrixType matrix,
ColSpMatrix out 
)
inlineprotected

Definition at line 476 of file PaStiXSupport.h.

◆ init()

template<typename _MatrixType, bool IsStrSym>
void Eigen::PastixLU< _MatrixType, IsStrSym >::init ( )
inlineprotected

Definition at line 469 of file PaStiXSupport.h.

Member Data Documentation

◆ m_structureIsUptodate

template<typename _MatrixType, bool IsStrSym>
bool Eigen::PastixLU< _MatrixType, IsStrSym >::m_structureIsUptodate
protected

Definition at line 504 of file PaStiXSupport.h.

◆ m_transposedStructure

template<typename _MatrixType, bool IsStrSym>
ColSpMatrix Eigen::PastixLU< _MatrixType, IsStrSym >::m_transposedStructure
protected

Definition at line 503 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:43