Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Eigen::PastixBase< Derived > Class Template Reference

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixBase< Derived >:
Inheritance graph
[legend]

Public Types

enum  { ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
 
typedef internal::pastix_traits< Derived >::MatrixType _MatrixType
 
typedef SparseMatrix< Scalar, ColMajorColSpMatrix
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 
typedef Matrix< Scalar, Dynamic, 1 > Vector
 

Public Member Functions

template<typename Rhs , typename Dest >
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< Derived >
template<typename Rhs , typename Dest >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
Derived & derived ()
 
const Derived & derived () const
 
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 ()
 
 ~SparseSolverBase ()
 

Protected Types

typedef SparseSolverBase< Derived > Base
 

Protected Member Functions

void analyzePattern (ColSpMatrix &mat)
 
void clean ()
 
void compute (ColSpMatrix &mat)
 
void factorize (ColSpMatrix &mat)
 
void init ()
 

Protected Attributes

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< Derived >
bool m_isInitialized
 

Detailed Description

template<class Derived>
class Eigen::PastixBase< Derived >

Definition at line 128 of file PaStiXSupport.h.

Member Typedef Documentation

◆ _MatrixType

template<class Derived>
typedef internal::pastix_traits<Derived>::MatrixType Eigen::PastixBase< Derived >::_MatrixType

Definition at line 137 of file PaStiXSupport.h.

◆ Base

template<class Derived>
typedef SparseSolverBase<Derived> Eigen::PastixBase< Derived >::Base
protected

Definition at line 131 of file PaStiXSupport.h.

◆ ColSpMatrix

template<class Derived>
typedef SparseMatrix<Scalar, ColMajor> Eigen::PastixBase< Derived >::ColSpMatrix

Definition at line 143 of file PaStiXSupport.h.

◆ MatrixType

template<class Derived>
typedef _MatrixType Eigen::PastixBase< Derived >::MatrixType

Definition at line 138 of file PaStiXSupport.h.

◆ RealScalar

template<class Derived>
typedef MatrixType::RealScalar Eigen::PastixBase< Derived >::RealScalar

Definition at line 140 of file PaStiXSupport.h.

◆ Scalar

template<class Derived>
typedef MatrixType::Scalar Eigen::PastixBase< Derived >::Scalar

Definition at line 139 of file PaStiXSupport.h.

◆ StorageIndex

template<class Derived>
typedef MatrixType::StorageIndex Eigen::PastixBase< Derived >::StorageIndex

Definition at line 141 of file PaStiXSupport.h.

◆ Vector

template<class Derived>
typedef Matrix<Scalar,Dynamic,1> Eigen::PastixBase< Derived >::Vector

Definition at line 142 of file PaStiXSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Derived>
anonymous enum
Enumerator
ColsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 144 of file PaStiXSupport.h.

Constructor & Destructor Documentation

◆ PastixBase()

template<class Derived>
Eigen::PastixBase< Derived >::PastixBase ( )
inline

Definition at line 151 of file PaStiXSupport.h.

◆ ~PastixBase()

template<class Derived>
Eigen::PastixBase< Derived >::~PastixBase ( )
inline

Definition at line 156 of file PaStiXSupport.h.

Member Function Documentation

◆ _solve_impl()

template<typename Base >
template<typename Rhs , typename Dest >
bool Eigen::PastixBase< Base >::_solve_impl ( const MatrixBase< Rhs > &  b,
MatrixBase< Dest > &  x 
) const

Definition at line 367 of file PaStiXSupport.h.

◆ analyzePattern()

template<class Derived >
void Eigen::PastixBase< Derived >::analyzePattern ( ColSpMatrix mat)
protected

Definition at line 307 of file PaStiXSupport.h.

◆ clean()

template<class Derived>
void Eigen::PastixBase< Derived >::clean ( )
inlineprotected

Definition at line 230 of file PaStiXSupport.h.

◆ cols()

template<class Derived>
Index Eigen::PastixBase< Derived >::cols ( void  ) const
inline

Definition at line 201 of file PaStiXSupport.h.

◆ compute()

template<class Derived >
void Eigen::PastixBase< Derived >::compute ( ColSpMatrix mat)
protected

Definition at line 295 of file PaStiXSupport.h.

◆ dparm() [1/2]

template<class Derived>
Array<double,DPARM_SIZE,1>& Eigen::PastixBase< Derived >::dparm ( )
inline

Returns a reference to the double vector DPARM of PaStiX parameters The statistics related to the different phases of factorization and solve are saved here as well

See also
analyzePattern() factorize()

Definition at line 187 of file PaStiXSupport.h.

◆ dparm() [2/2]

template<class Derived>
double& Eigen::PastixBase< Derived >::dparm ( int  idxparam)
inline

Return a reference to a particular index parameter of the DPARM vector

See also
dparm()

Definition at line 196 of file PaStiXSupport.h.

◆ factorize()

template<class Derived >
void Eigen::PastixBase< Derived >::factorize ( ColSpMatrix mat)
protected

Definition at line 338 of file PaStiXSupport.h.

◆ info()

template<class Derived>
ComputationInfo Eigen::PastixBase< Derived >::info ( ) const
inline

Reports whether previous computation was successful.

Returns
Success if computation was successful, NumericalIssue if the PaStiX reports a problem InvalidInput if the input matrix is invalid
See also
iparm()

Definition at line 212 of file PaStiXSupport.h.

◆ init()

template<class Derived >
void Eigen::PastixBase< Derived >::init ( )
protected

Initialize the PaStiX data structure. A first call to this function fills iparm and dparm with the default PaStiX parameters

See also
iparm() dparm()

Definition at line 259 of file PaStiXSupport.h.

◆ iparm() [1/2]

template<class Derived>
Array<StorageIndex,IPARM_SIZE,1>& Eigen::PastixBase< Derived >::iparm ( )
inline

Returns a reference to the integer vector IPARM of PaStiX parameters to modify the default parameters. The statistics related to the different phases of factorization and solve are saved here as well

See also
analyzePattern() factorize()

Definition at line 169 of file PaStiXSupport.h.

◆ iparm() [2/2]

template<class Derived>
int& Eigen::PastixBase< Derived >::iparm ( int  idxparam)
inline

Return a reference to a particular index parameter of the IPARM vector

See also
iparm()

Definition at line 178 of file PaStiXSupport.h.

◆ rows()

template<class Derived>
Index Eigen::PastixBase< Derived >::rows ( void  ) const
inline

Definition at line 202 of file PaStiXSupport.h.

Member Data Documentation

◆ m_analysisIsOk

template<class Derived>
int Eigen::PastixBase< Derived >::m_analysisIsOk
protected

Definition at line 242 of file PaStiXSupport.h.

◆ m_comm

template<class Derived>
int Eigen::PastixBase< Derived >::m_comm
mutableprotected

Definition at line 246 of file PaStiXSupport.h.

◆ m_dparm

template<class Derived>
Array<double,DPARM_SIZE,1> Eigen::PastixBase< Derived >::m_dparm
mutableprotected

Definition at line 248 of file PaStiXSupport.h.

◆ m_factorizationIsOk

template<class Derived>
int Eigen::PastixBase< Derived >::m_factorizationIsOk
protected

Definition at line 243 of file PaStiXSupport.h.

◆ m_info

template<class Derived>
ComputationInfo Eigen::PastixBase< Derived >::m_info
mutableprotected

Definition at line 244 of file PaStiXSupport.h.

◆ m_initisOk

template<class Derived>
int Eigen::PastixBase< Derived >::m_initisOk
protected

Definition at line 241 of file PaStiXSupport.h.

◆ m_invp

template<class Derived>
Matrix<StorageIndex,Dynamic,1> Eigen::PastixBase< Derived >::m_invp
mutableprotected

Definition at line 250 of file PaStiXSupport.h.

◆ m_iparm

template<class Derived>
Array<int,IPARM_SIZE,1> Eigen::PastixBase< Derived >::m_iparm
mutableprotected

Definition at line 247 of file PaStiXSupport.h.

◆ m_pastixdata

template<class Derived>
pastix_data_t* Eigen::PastixBase< Derived >::m_pastixdata
mutableprotected

Definition at line 245 of file PaStiXSupport.h.

◆ m_perm

template<class Derived>
Matrix<StorageIndex,Dynamic,1> Eigen::PastixBase< Derived >::m_perm
mutableprotected

Definition at line 249 of file PaStiXSupport.h.

◆ m_size

template<class Derived>
int Eigen::PastixBase< Derived >::m_size
mutableprotected

Definition at line 251 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:40