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

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

Public Types
enum	{ UpLo }

typedef PastixBase< PastixLLT< MatrixType, UpLo_ > >	Base

typedef Base::ColSpMatrix	ColSpMatrix

typedef MatrixType_	MatrixType

Public Types inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
enum

typedef SparseMatrix< Scalar, ColMajor >	ColSpMatrix

typedef MatrixType_	MatrixType

typedef internal::pastix_traits< PastixLLT< MatrixType_, UpLo_ > >::MatrixType	MatrixType_

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::Scalar	Scalar

typedef MatrixType::StorageIndex	StorageIndex

typedef Matrix< Scalar, Dynamic, 1 >	Vector

Public Member Functions
void	analyzePattern (const MatrixType &matrix)

void	compute (const MatrixType &matrix)

void	factorize (const MatrixType &matrix)

	PastixLLT ()

	PastixLLT (const MatrixType &matrix)

Public Member Functions inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
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 ()

int &	iparm (int idxparam)

	PastixBase ()

Index	rows () const

	~PastixBase ()

Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
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 (SparseSolverBase &&other)

	~SparseSolverBase ()

Protected Member Functions
void	grabMatrix (const MatrixType &matrix, ColSpMatrix &out)

void	init ()

Protected Member Functions inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
void	analyzePattern (ColSpMatrix &mat)

void	clean ()

void	compute (ColSpMatrix &mat)

PastixLLT< MatrixType_, UpLo_ > &	derived ()

const PastixLLT< MatrixType_, UpLo_ > &	derived () const

void	factorize (ColSpMatrix &mat)

void	init ()

Protected Attributes
Array< int, IPARM_SIZE, 1 >	m_iparm

Protected Attributes inherited from Eigen::PastixBase< PastixLLT< MatrixType_, UpLo_ > >
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

bool	m_isInitialized

pastix_data_t *	m_pastixdata

Matrix< StorageIndex, Dynamic, 1 >	m_perm

int	m_size

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

This class follows the sparse solver concept .

See also: Sparse solver concept, class SimplicialLLT

Definition at line 526 of file PaStiXSupport.h.

Member Typedef Documentation

◆ Base

template<typename MatrixType_ , int UpLo_>

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

Definition at line 530 of file PaStiXSupport.h.

◆ ColSpMatrix

template<typename MatrixType_ , int UpLo_>

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

Definition at line 531 of file PaStiXSupport.h.

◆ MatrixType

template<typename MatrixType_ , int UpLo_>

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

Definition at line 529 of file PaStiXSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename MatrixType_ , int UpLo_>

anonymous enum

Enumerator
UpLo

Definition at line 534 of file PaStiXSupport.h.

534 { UpLo = UpLo_ };

Eigen::PastixLLT::UpLo

@ UpLo

Definition: PaStiXSupport.h:534

Constructor & Destructor Documentation

◆ PastixLLT() [1/2]

template<typename MatrixType_ , int UpLo_>

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

inline

Definition at line 535 of file PaStiXSupport.h.

                 : Base()
     {
       init();
     }

◆ PastixLLT() [2/2]

template<typename MatrixType_ , int UpLo_>

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

inlineexplicit

Definition at line 540 of file PaStiXSupport.h.

                                                 :Base()
     {
       init();
       compute(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()

Definition at line 560 of file PaStiXSupport.h.

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

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

Definition at line 549 of file PaStiXSupport.h.

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

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

Definition at line 569 of file PaStiXSupport.h.

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

◆ grabMatrix()

template<typename MatrixType_ , int UpLo_>

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

inlineprotected

Definition at line 584 of file PaStiXSupport.h.

     {
       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);
     }

◆ init()

template<typename MatrixType_ , int UpLo_>

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

inlineprotected

Definition at line 578 of file PaStiXSupport.h.

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

Member Data Documentation

◆ m_iparm

template<typename MatrixType_ , int UpLo_>

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

mutableprotected

Definition at line 249 of file PaStiXSupport.h.

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

PaStiXSupport.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ ColSpMatrix

◆ MatrixType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PastixLLT() [1/2]

◆ PastixLLT() [2/2]

Member Function Documentation

◆ analyzePattern()

◆ compute()

◆ factorize()

◆ grabMatrix()

◆ init()

Member Data Documentation

◆ m_iparm

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