Eigen::PastixLLT< MatrixType_, UpLo_ > Class Template Reference

A sparse direct supernodal Cholesky (LLT) factorization and solver based on the PaStiX library. More...

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixLLT< MatrixType_, UpLo_ >:

Public Types
enum	{ UpLo = UpLo_ }
typedef MatrixType_	MatrixType
typedef PastixBase< PastixLLT< MatrixType, UpLo_ > >	Base
typedef Base::ColSpMatrix	ColSpMatrix
Public Types inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
enum
typedef internal::pastix_traits< PastixLLT< MatrixType_, UpLo_ > >::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
	PastixLLT ()
	PastixLLT (const MatrixType &matrix)
void	compute (const MatrixType &matrix)
void	analyzePattern (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
Public Member Functions inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
	PastixBase ()
	~PastixBase ()
bool	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) 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...
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 Member Functions
void	init ()
void	grabMatrix (const MatrixType &matrix, ColSpMatrix &out)
Protected Member Functions inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
void	init ()
void	analyzePattern (ColSpMatrix &mat)
void	factorize (ColSpMatrix &mat)
void	clean ()
void	compute (ColSpMatrix &mat)
PastixLLT< MatrixType_, UpLo_ > &	derived ()
const PastixLLT< MatrixType_, UpLo_ > &	derived () const

Protected Attributes
Array< int, IPARM_SIZE, 1 >	m_iparm
Protected Attributes inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
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

Additional Inherited Members
Protected Types inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
typedef SparseSolverBase< PastixLLT< MatrixType_, UpLo_ > >	Base

Detailed Description

template<typename MatrixType_, int UpLo_>
class Eigen::PastixLLT< MatrixType_, UpLo_ >

A sparse direct supernodal Cholesky (LLT) factorization and solver based on the PaStiX library.

This class is used to solve the linear systems A.X = B via a LL^T supernodal Cholesky factorization available in the PaStiX library. The matrix A should be symmetric and positive definite WARNING Selfadjoint complex matrices are not supported in the current version of PaStiX The vectors or matrices X and B can be either dense or sparse

Template Parameters

MatrixType	the type of the sparse matrix A, it must be a SparseMatrix<>
UpLo	The part of the matrix to use : Lower or Upper. The default is Lower as required by PaStiX

\implsparsesolverconcept

See also

Sparse solver concept, class SimplicialLLT

Member Typedef Documentation

Base

template<typename MatrixType_ , int UpLo_>

typedef PastixBase<PastixLLT<MatrixType, UpLo_> > Eigen::PastixLLT< MatrixType_, UpLo_ >::Base

ColSpMatrix

template<typename MatrixType_ , int UpLo_>

typedef Base::ColSpMatrix Eigen::PastixLLT< MatrixType_, UpLo_ >::ColSpMatrix

MatrixType

template<typename MatrixType_ , int UpLo_>

typedef MatrixType_ Eigen::PastixLLT< MatrixType_, UpLo_ >::MatrixType

Member Enumeration Documentation

anonymous enum

template<typename MatrixType_ , int UpLo_>

anonymous enum

Enumerator
UpLo

{ UpLo = UpLo_ };

Constructor & Destructor Documentation

PastixLLT() [1/2]

template<typename MatrixType_ , int UpLo_>

Eigen::PastixLLT< MatrixType_, UpLo_ >::PastixLLT ( )

inline

: Base() { init(); }

References Eigen::PastixLLT< MatrixType_, UpLo_ >::init().

PastixLLT() [2/2]

template<typename MatrixType_ , int UpLo_>

Eigen::PastixLLT< MatrixType_, UpLo_ >::PastixLLT ( const MatrixType &  matrix )

inlineexplicit

                                               : Base() {
    init();
    compute(matrix);
  }

References Eigen::PastixLLT< MatrixType_, UpLo_ >::compute(), Eigen::PastixLLT< MatrixType_, UpLo_ >::init(), and matrix().

Member Function Documentation

analyzePattern()

template<typename MatrixType_ , int UpLo_>

void Eigen::PastixLLT< MatrixType_, UpLo_ >::analyzePattern ( const MatrixType &  matrix )

inline

Compute the LL^T symbolic factorization of matrix using its sparsity pattern The result of this operation can be used with successive matrices having the same pattern as matrix

See also

factorize()

                                                {
    ColSpMatrix temp;
    grabMatrix(matrix, temp);
    Base::analyzePattern(temp);
  }

References Eigen::PastixBase< Derived >::analyzePattern(), Eigen::PastixLLT< MatrixType_, UpLo_ >::grabMatrix(), and matrix().

compute()

template<typename MatrixType_ , int UpLo_>

void Eigen::PastixLLT< MatrixType_, UpLo_ >::compute ( const MatrixType &  matrix )

inline

Compute the L factor of the LL^T supernodal factorization of matrix

See also

analyzePattern() factorize()

                                         {
    ColSpMatrix temp;
    grabMatrix(matrix, temp);
    Base::compute(temp);
  }

References Eigen::PastixBase< Derived >::compute(), Eigen::PastixLLT< MatrixType_, UpLo_ >::grabMatrix(), and matrix().

Referenced by Eigen::PastixLLT< MatrixType_, UpLo_ >::PastixLLT().

factorize()

template<typename MatrixType_ , int UpLo_>

void Eigen::PastixLLT< MatrixType_, UpLo_ >::factorize ( const MatrixType &  matrix )

inline

Compute the LL^T supernodal numerical factorization of matrix

See also

analyzePattern()

                                           {
    ColSpMatrix temp;
    grabMatrix(matrix, temp);
    Base::factorize(temp);
  }

References Eigen::PastixBase< Derived >::factorize(), Eigen::PastixLLT< MatrixType_, UpLo_ >::grabMatrix(), and matrix().

grabMatrix()

template<typename MatrixType_ , int UpLo_>

void Eigen::PastixLLT< MatrixType_, UpLo_ >::grabMatrix ( const MatrixType &  matrix, ColSpMatrix &  out  )

inlineprotected

                                                              {
    out.resize(matrix.rows(), matrix.cols());
    // Pastix supports only lower, column-major matrices
    out.template selfadjointView<Lower>() = matrix.template selfadjointView<UpLo>();
    internal::c_to_fortran_numbering(out);
  }

References Eigen::internal::c_to_fortran_numbering(), matrix(), and out().

Referenced by Eigen::PastixLLT< MatrixType_, UpLo_ >::analyzePattern(), Eigen::PastixLLT< MatrixType_, UpLo_ >::compute(), and Eigen::PastixLLT< MatrixType_, UpLo_ >::factorize().

init()

template<typename MatrixType_ , int UpLo_>

void Eigen::PastixLLT< MatrixType_, UpLo_ >::init ( )

inlineprotected

              {
    m_iparm(IPARM_SYM) = API_SYM_YES;
    m_iparm(IPARM_FACTORIZATION) = API_FACT_LLT;
  }

References Eigen::PastixLLT< MatrixType_, UpLo_ >::m_iparm.

Referenced by Eigen::PastixLLT< MatrixType_, UpLo_ >::PastixLLT().

Member Data Documentation

m_iparm

template<typename MatrixType_ , int UpLo_>

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

mutableprotected

Referenced by Eigen::PastixLLT< MatrixType_, UpLo_ >::init().

---

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

• PaStiXSupport.h