Eigen::PastixBase< Derived > Class Template Reference

Inheritance diagram for Eigen::PastixBase< Derived >:

Collaboration diagram for Eigen::PastixBase< Derived >:

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

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

Protected Member Functions
void	init ()
void	analyzePattern (ColSpMatrix &mat)
void	factorize (ColSpMatrix &mat)
void	clean ()
void	compute (ColSpMatrix &mat)

Protected Attributes
int	m_initisOk
int	m_analysisIsOk
int	m_factorizationIsOk
bool	m_isInitialized
ComputationInfo	m_info
pastix_data_t *	m_pastixdata
int	m_comm
Matrix< int, IPARM_SIZE, 1 >	m_iparm
Matrix< double, DPARM_SIZE, 1 >	m_dparm
Matrix< Index, Dynamic, 1 >	m_perm
Matrix< Index, Dynamic, 1 >	m_invp
int	m_size

Detailed Description

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

Definition at line 120 of file PaStiXSupport.h.

Member Function Documentation

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.

    {
      return m_dparm; 
    }

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.

    {
      return m_dparm(idxparam);
    }

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.

    {
      eigen_assert(m_isInitialized && "Decomposition is not initialized.");
      return m_info;
    }

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.

{
  m_size = 0; 
  m_iparm.setZero(IPARM_SIZE);
  m_dparm.setZero(DPARM_SIZE);
  
  m_iparm(IPARM_MODIFY_PARAMETER) = API_NO;
  pastix(&m_pastixdata, MPI_COMM_WORLD,
         0, 0, 0, 0,
         0, 0, 0, 1, m_iparm.data(), m_dparm.data());
  
  m_iparm[IPARM_MATRIX_VERIFICATION] = API_NO;
  m_iparm[IPARM_VERBOSE]             = 2;
  m_iparm[IPARM_ORDERING]            = API_ORDER_SCOTCH;
  m_iparm[IPARM_INCOMPLETE]          = API_NO;
  m_iparm[IPARM_OOC_LIMIT]           = 2000;
  m_iparm[IPARM_RHS_MAKING]          = API_RHS_B;
  m_iparm(IPARM_MATRIX_VERIFICATION) = API_NO;
  
  m_iparm(IPARM_START_TASK) = API_TASK_INIT;
  m_iparm(IPARM_END_TASK) = API_TASK_INIT;
  internal::eigen_pastix(&m_pastixdata, MPI_COMM_WORLD, 0, 0, 0, (Scalar*)0,
                         0, 0, 0, 0, m_iparm.data(), m_dparm.data());
  
  // Check the returned error
  if(m_iparm(IPARM_ERROR_NUMBER)) {
    m_info = InvalidInput;
    m_initisOk = false;
  }
  else { 
    m_info = Success;
    m_initisOk = true;
  }
}

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.

    {
      return m_iparm; 
    }

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.

    {
      return m_iparm(idxparam);
    }

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 using the current decomposition of A.

See also

compute()

Definition at line 149 of file PaStiXSupport.h.

    {
      eigen_assert(m_isInitialized && "Pastix solver is not initialized.");
      eigen_assert(rows()==b.rows()
                && "PastixBase::solve(): invalid number of rows of the right hand side matrix b");
      return internal::solve_retval<PastixBase, Rhs>(*this, b.derived());
    }

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 using the current decomposition of A.

See also

compute()

Definition at line 229 of file PaStiXSupport.h.

    {
      eigen_assert(m_isInitialized && "Pastix LU, LLT or LDLT is not initialized.");
      eigen_assert(rows()==b.rows()
                && "PastixBase::solve(): invalid number of rows of the right hand side matrix b");
      return internal::sparse_solve_retval<PastixBase, Rhs>(*this, b.derived());
    }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/PaStiXSupport/PaStiXSupport.h