Public Types | Public Member Functions | 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

typedef internal::pastix_traits< Derived >::MatrixType _MatrixType
 
typedef SparseMatrix< Scalar, ColMajor > ColSpMatrix
 
typedef MatrixType::Index Index
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > Vector
 

Public Member Functions

template<typename Rhs , typename Dest >
bool _solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const
 
Index cols () const
 
Derived & derived ()
 
const Derived & derived () const
 
Array< RealScalar, IPARM_SIZE, 1 > & dparm ()
 
double & dparm (int idxparam)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
Array< Index, IPARM_SIZE, 1 > & iparm ()
 
int & iparm (int idxparam)
 
 PastixBase ()
 
Index rows () const
 
template<typename Rhs >
const internal::solve_retval< PastixBase, Rhs > solve (const MatrixBase< Rhs > &b) const
 
template<typename Rhs >
const internal::sparse_solve_retval< PastixBase, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 ~PastixBase ()
 

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
 
Matrix< double, DPARM_SIZE, 1 > m_dparm
 
int m_factorizationIsOk
 
ComputationInfo m_info
 
int m_initisOk
 
Matrix< Index, Dynamic, 1 > m_invp
 
Matrix< int, IPARM_SIZE, 1 > m_iparm
 
bool m_isInitialized
 
pastix_data_t * m_pastixdata
 
Matrix< Index, Dynamic, 1 > m_perm
 
int m_size
 

Additional Inherited Members

- Private Member Functions inherited from Eigen::internal::noncopyable
 noncopyable ()
 
 ~noncopyable ()
 

Detailed Description

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

Definition at line 120 of file PaStiXSupport.h.

Member Typedef Documentation

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

Definition at line 123 of file PaStiXSupport.h.

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

Definition at line 129 of file PaStiXSupport.h.

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

Definition at line 127 of file PaStiXSupport.h.

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

Definition at line 124 of file PaStiXSupport.h.

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

Definition at line 126 of file PaStiXSupport.h.

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

Definition at line 125 of file PaStiXSupport.h.

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

Definition at line 128 of file PaStiXSupport.h.

Constructor & Destructor Documentation

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

Definition at line 133 of file PaStiXSupport.h.

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

Definition at line 138 of file PaStiXSupport.h.

Member Function Documentation

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

Definition at line 388 of file PaStiXSupport.h.

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

Definition at line 328 of file PaStiXSupport.h.

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

Definition at line 249 of file PaStiXSupport.h.

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

Definition at line 206 of file PaStiXSupport.h.

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

Definition at line 315 of file PaStiXSupport.h.

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

Definition at line 160 of file PaStiXSupport.h.

template<class Derived>
const Derived& Eigen::PastixBase< Derived >::derived ( ) const
inline

Definition at line 164 of file PaStiXSupport.h.

template<class Derived>
Array<RealScalar,IPARM_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 192 of file PaStiXSupport.h.

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 201 of file PaStiXSupport.h.

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

Definition at line 359 of file PaStiXSupport.h.

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

Reports whether previous computation was successful.

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

Definition at line 217 of file PaStiXSupport.h.

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 279 of file PaStiXSupport.h.

template<class Derived>
Array<Index,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 174 of file PaStiXSupport.h.

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 183 of file PaStiXSupport.h.

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

Definition at line 207 of file PaStiXSupport.h.

template<class Derived>
template<typename Rhs >
const internal::solve_retval<PastixBase, Rhs> Eigen::PastixBase< Derived >::solve ( const MatrixBase< Rhs > &  b) const
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See also
compute()

Definition at line 149 of file PaStiXSupport.h.

template<class Derived>
template<typename Rhs >
const internal::sparse_solve_retval<PastixBase, Rhs> Eigen::PastixBase< Derived >::solve ( const SparseMatrixBase< Rhs > &  b) const
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See also
compute()

Definition at line 229 of file PaStiXSupport.h.

Member Data Documentation

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

Definition at line 261 of file PaStiXSupport.h.

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

Definition at line 266 of file PaStiXSupport.h.

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

Definition at line 268 of file PaStiXSupport.h.

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

Definition at line 262 of file PaStiXSupport.h.

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

Definition at line 264 of file PaStiXSupport.h.

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

Definition at line 260 of file PaStiXSupport.h.

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

Definition at line 270 of file PaStiXSupport.h.

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

Definition at line 267 of file PaStiXSupport.h.

template<class Derived>
bool Eigen::PastixBase< Derived >::m_isInitialized
protected

Definition at line 263 of file PaStiXSupport.h.

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

Definition at line 265 of file PaStiXSupport.h.

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

Definition at line 269 of file PaStiXSupport.h.

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

Definition at line 271 of file PaStiXSupport.h.

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

acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:37