Eigen::PastixBase< Derived > Class Template Reference

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixBase< Derived >:

Public Types
enum	{ ColsAtCompileTime = MatrixType::ColsAtCompileTime , MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
typedef internal::pastix_traits< Derived >::MatrixType	MatrixType_
typedef MatrixType_	MatrixType
typedef MatrixType::Scalar	Scalar
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::StorageIndex	StorageIndex
typedef Matrix< Scalar, Dynamic, 1 >	Vector
typedef SparseMatrix< Scalar, ColMajor >	ColSpMatrix

Public Member Functions
	PastixBase ()
	~PastixBase ()
template<typename Rhs , typename Dest >
bool	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const
Array< StorageIndex, IPARM_SIZE, 1 > &	iparm ()
int &	iparm (int idxparam)
Array< double, DPARM_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 , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	SparseSolverBase ()
	SparseSolverBase (SparseSolverBase &&other)
	~SparseSolverBase ()
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
template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Types
typedef SparseSolverBase< Derived >	Base

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

Protected Attributes
int	m_initisOk
int	m_analysisIsOk
int	m_factorizationIsOk
ComputationInfo	m_info
pastix_data_t *	m_pastixdata
int	m_comm
Array< int, IPARM_SIZE, 1 >	m_iparm
Array< double, DPARM_SIZE, 1 >	m_dparm
Matrix< StorageIndex, Dynamic, 1 >	m_perm
Matrix< StorageIndex, Dynamic, 1 >	m_invp
int	m_size
bool	m_isInitialized
Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool	m_isInitialized

Member Typedef Documentation

Base

template<class Derived >

typedef SparseSolverBase<Derived> Eigen::PastixBase< Derived >::Base

protected

ColSpMatrix

template<class Derived >

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

MatrixType

template<class Derived >

typedef MatrixType_ Eigen::PastixBase< Derived >::MatrixType

MatrixType_

template<class Derived >

typedef internal::pastix_traits<Derived>::MatrixType Eigen::PastixBase< Derived >::MatrixType_

RealScalar

template<class Derived >

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

Scalar

template<class Derived >

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

StorageIndex

template<class Derived >

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

Vector

template<class Derived >

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

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime

{ ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime };

Constructor & Destructor Documentation

PastixBase()

template<class Derived >

Eigen::PastixBase< Derived >::PastixBase ( )

inline

               : m_initisOk(false), m_analysisIsOk(false), m_factorizationIsOk(false), m_pastixdata(0), m_size(0) {
    init();
  }

References Eigen::PastixBase< Derived >::init().

~PastixBase()

template<class Derived >

Eigen::PastixBase< Derived >::~PastixBase ( )

inline

{ clean(); }

References Eigen::PastixBase< Derived >::clean().

Member Function Documentation

_solve_impl() [1/2]

template<typename Base >

template<typename Rhs , typename Dest >

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

                                                                                      {
  eigen_assert(m_isInitialized && "The matrix should be factorized first");
  EIGEN_STATIC_ASSERT((Dest::Flags & RowMajorBit) == 0, THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
  int rhs = 1;
 
  x = b; /* on return, x is overwritten by the computed solution */
 
  for (int i = 0; i < b.cols(); i++) {
    m_iparm[IPARM_START_TASK] = API_TASK_SOLVE;
    m_iparm[IPARM_END_TASK] = API_TASK_REFINE;
 
    internal::eigen_pastix(&m_pastixdata, MPI_COMM_WORLD, internal::convert_index<int>(x.rows()), 0, 0, 0,
                           m_perm.data(), m_invp.data(), &x(0, i), rhs, m_iparm.data(), m_dparm.data());
  }
 
  // Check the returned error
  m_info = m_iparm(IPARM_ERROR_NUMBER) == 0 ? Success : NumericalIssue;
 
  return m_iparm(IPARM_ERROR_NUMBER) == 0;
}

References b, eigen_assert, Eigen::internal::eigen_pastix(), EIGEN_STATIC_ASSERT, i, Eigen::NumericalIssue, Eigen::RowMajorBit, Eigen::Success, and plotDoE::x.

_solve_impl() [2/2]

template<class Derived >

template<typename Rhs , typename Dest >

void Eigen::SparseSolverBase< Derived >::_solve_impl ( typename Rhs  , typename Dest    )

inline

default implementation of solving with a sparse rhs

                                                                                       {
    internal::solve_sparse_through_dense_panels(derived(), b.derived(), dest.derived());
  }

analyzePattern()

template<class Derived >

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

protected

                                                         {
  eigen_assert(m_initisOk && "The initialization of PaSTiX failed");
 
  // clean previous calls
  if (m_size > 0) clean();
 
  m_size = internal::convert_index<int>(mat.rows());
  m_perm.resize(m_size);
  m_invp.resize(m_size);
 
  m_iparm(IPARM_START_TASK) = API_TASK_ORDERING;
  m_iparm(IPARM_END_TASK) = API_TASK_ANALYSE;
  internal::eigen_pastix(&m_pastixdata, MPI_COMM_WORLD, m_size, mat.outerIndexPtr(), mat.innerIndexPtr(),
                         mat.valuePtr(), m_perm.data(), m_invp.data(), 0, 0, m_iparm.data(), m_dparm.data());
 
  // Check the returned error
  if (m_iparm(IPARM_ERROR_NUMBER)) {
    m_info = NumericalIssue;
    m_analysisIsOk = false;
  } else {
    m_info = Success;
    m_analysisIsOk = true;
  }
}

References eigen_assert, Eigen::internal::eigen_pastix(), Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::innerIndexPtr(), Eigen::NumericalIssue, Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::outerIndexPtr(), Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::rows(), Eigen::Success, and Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::valuePtr().

Referenced by Eigen::PastixLU< MatrixType_, IsStrSym >::analyzePattern(), Eigen::PastixLLT< MatrixType_, UpLo_ >::analyzePattern(), and Eigen::PastixLDLT< MatrixType_, UpLo_ >::analyzePattern().

clean()

template<class Derived >

void Eigen::PastixBase< Derived >::clean ( )

inlineprotected

               {
    eigen_assert(m_initisOk && "The Pastix structure should be allocated first");
    m_iparm(IPARM_START_TASK) = API_TASK_CLEAN;
    m_iparm(IPARM_END_TASK) = API_TASK_CLEAN;
    internal::eigen_pastix(&m_pastixdata, MPI_COMM_WORLD, 0, 0, 0, (Scalar *)0, m_perm.data(), m_invp.data(), 0, 0,
                           m_iparm.data(), m_dparm.data());
  }

References Eigen::PlainObjectBase< Derived >::data(), eigen_assert, Eigen::internal::eigen_pastix(), Eigen::PastixBase< Derived >::m_dparm, Eigen::PastixBase< Derived >::m_initisOk, Eigen::PastixBase< Derived >::m_invp, Eigen::PastixBase< Derived >::m_iparm, Eigen::PastixBase< Derived >::m_pastixdata, and Eigen::PastixBase< Derived >::m_perm.

Referenced by Eigen::PastixBase< Derived >::~PastixBase().

cols()

template<class Derived >

Index Eigen::PastixBase< Derived >::cols ( ) const

inline

{ return m_size; }

References Eigen::PastixBase< Derived >::m_size.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

compute()

template<class Derived >

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

protected

                                                  {
  eigen_assert(mat.rows() == mat.cols() && "The input matrix should be squared");
 
  analyzePattern(mat);
  factorize(mat);
 
  m_iparm(IPARM_MATRIX_VERIFICATION) = API_NO;
}

References Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::cols(), eigen_assert, and Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::rows().

Referenced by Eigen::PastixLU< MatrixType_, IsStrSym >::compute(), Eigen::PastixLLT< MatrixType_, UpLo_ >::compute(), and Eigen::PastixLDLT< MatrixType_, UpLo_ >::compute().

derived() [1/2]

template<class Derived >

Derived& Eigen::SparseSolverBase< Derived >::derived

inlineprotected

{ return *static_cast<Derived*>(this); }

derived() [2/2]

template<class Derived >

const Derived& Eigen::SparseSolverBase< Derived >::derived

inlineprotected

{ return *static_cast<const Derived*>(this); }

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()

{ return m_dparm; }

References Eigen::PastixBase< Derived >::m_dparm.

Referenced by test_pastix_T().

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()

{ return m_dparm(idxparam); }

References Eigen::PastixBase< Derived >::m_dparm.

factorize()

template<class Derived >

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

protected

                                                    {
  //   if(&m_cpyMat != &mat) m_cpyMat = mat;
  eigen_assert(m_analysisIsOk && "The analysis phase should be called before the factorization phase");
  m_iparm(IPARM_START_TASK) = API_TASK_NUMFACT;
  m_iparm(IPARM_END_TASK) = API_TASK_NUMFACT;
  m_size = internal::convert_index<int>(mat.rows());
 
  internal::eigen_pastix(&m_pastixdata, MPI_COMM_WORLD, m_size, mat.outerIndexPtr(), mat.innerIndexPtr(),
                         mat.valuePtr(), m_perm.data(), m_invp.data(), 0, 0, m_iparm.data(), m_dparm.data());
 
  // Check the returned error
  if (m_iparm(IPARM_ERROR_NUMBER)) {
    m_info = NumericalIssue;
    m_factorizationIsOk = false;
    m_isInitialized = false;
  } else {
    m_info = Success;
    m_factorizationIsOk = true;
    m_isInitialized = true;
  }
}

References eigen_assert, Eigen::internal::eigen_pastix(), Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::innerIndexPtr(), Eigen::NumericalIssue, Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::outerIndexPtr(), Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::rows(), Eigen::Success, and Eigen::SparseMatrix< Scalar_, Options_, StorageIndex_ >::valuePtr().

Referenced by Eigen::PastixLU< MatrixType_, IsStrSym >::factorize(), Eigen::PastixLLT< MatrixType_, UpLo_ >::factorize(), and Eigen::PastixLDLT< MatrixType_, UpLo_ >::factorize().

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()

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

References eigen_assert, Eigen::PastixBase< Derived >::m_info, and Eigen::PastixBase< Derived >::m_isInitialized.

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()

                               {
  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] = API_VERBOSE_NOT;
  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;
  }
}

References Eigen::internal::eigen_pastix(), Eigen::InvalidInput, and Eigen::Success.

Referenced by Eigen::PastixBase< Derived >::PastixBase().

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()

{ return m_iparm; }

References Eigen::PastixBase< Derived >::m_iparm.

Referenced by test_pastix_T().

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()

{ return m_iparm(idxparam); }

References Eigen::PastixBase< Derived >::m_iparm.

rows()

template<class Derived >

Index Eigen::PastixBase< Derived >::rows ( ) const

inline

{ return m_size; }

References Eigen::PastixBase< Derived >::m_size.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

Member Data Documentation

m_analysisIsOk

template<class Derived >

int Eigen::PastixBase< Derived >::m_analysisIsOk

protected

m_comm

template<class Derived >

int Eigen::PastixBase< Derived >::m_comm

mutableprotected

m_dparm

template<class Derived >

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

mutableprotected

Referenced by Eigen::PastixBase< Derived >::clean(), and Eigen::PastixBase< Derived >::dparm().

m_factorizationIsOk

template<class Derived >

int Eigen::PastixBase< Derived >::m_factorizationIsOk

protected

m_info

template<class Derived >

ComputationInfo Eigen::PastixBase< Derived >::m_info

mutableprotected

Referenced by Eigen::PastixBase< Derived >::info().

m_initisOk

template<class Derived >

int Eigen::PastixBase< Derived >::m_initisOk

protected

Referenced by Eigen::PastixBase< Derived >::clean().

m_invp

template<class Derived >

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

mutableprotected

Referenced by Eigen::PastixBase< Derived >::clean().

m_iparm

template<class Derived >

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

mutableprotected

Referenced by Eigen::PastixBase< Derived >::clean(), and Eigen::PastixBase< Derived >::iparm().

m_isInitialized

template<class Derived >

bool Eigen::SparseSolverBase< Derived >::m_isInitialized

mutableprotected

Referenced by Eigen::PastixBase< Derived >::info().

m_pastixdata

template<class Derived >

pastix_data_t* Eigen::PastixBase< Derived >::m_pastixdata

mutableprotected

Referenced by Eigen::PastixBase< Derived >::clean().

m_perm

template<class Derived >

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

mutableprotected

Referenced by Eigen::PastixBase< Derived >::clean().

m_size

template<class Derived >

int Eigen::PastixBase< Derived >::m_size

mutableprotected

Referenced by Eigen::PastixBase< Derived >::cols(), and Eigen::PastixBase< Derived >::rows().

---

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

• PaStiXSupport.h