Eigen::PastixLDLT Class Reference

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

#include <PaStiXSupport.h>

Public Types
enum	{ UpLo = _UpLo }
typedef PastixBase< PastixLDLT< MatrixType, _UpLo > >	Base
typedef Base::ColSpMatrix	ColSpMatrix
typedef _MatrixType	MatrixType

Public Member Functions
void	analyzePattern (const MatrixType &matrix)
void	compute (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
	PastixLDLT ()
	PastixLDLT (const MatrixType &matrix)

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

Protected Attributes
Array< int, IPARM_SIZE, 1 >	m_iparm

Detailed Description

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 LDL^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 SimplicialLDLT

Definition at line 33 of file PaStiXSupport.h.

Member Typedef Documentation

Base

typedef PastixBase<PastixLDLT<MatrixType, _UpLo> > Eigen::PastixLDLT::Base

Definition at line 612 of file PaStiXSupport.h.

ColSpMatrix

typedef Base::ColSpMatrix Eigen::PastixLDLT::ColSpMatrix

Definition at line 613 of file PaStiXSupport.h.

MatrixType

typedef _MatrixType Eigen::PastixLDLT::MatrixType

Definition at line 611 of file PaStiXSupport.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UpLo

Definition at line 616 of file PaStiXSupport.h.

Constructor & Destructor Documentation

PastixLDLT() [1/2]

Eigen::PastixLDLT::PastixLDLT ( )

inline

Definition at line 617 of file PaStiXSupport.h.

PastixLDLT() [2/2]

Eigen::PastixLDLT::PastixLDLT ( const MatrixType &  matrix )

inlineexplicit

Definition at line 622 of file PaStiXSupport.h.

Member Function Documentation

analyzePattern()

void Eigen::PastixLDLT::analyzePattern ( const MatrixType &  matrix )

inline

Compute the LDL^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 642 of file PaStiXSupport.h.

compute()

void Eigen::PastixLDLT::compute ( const MatrixType &  matrix )

inline

Compute the L and D factors of the LDL^T factorization of matrix

See also

analyzePattern() factorize()

Definition at line 631 of file PaStiXSupport.h.

factorize()

void Eigen::PastixLDLT::factorize ( const MatrixType &  matrix )

inline

Compute the LDL^T supernodal numerical factorization of matrix

Definition at line 651 of file PaStiXSupport.h.

grabMatrix()

void Eigen::PastixLDLT::grabMatrix ( const MatrixType &  matrix, ColSpMatrix &  out  )

inlineprotected

Definition at line 667 of file PaStiXSupport.h.

init()

void Eigen::PastixLDLT::init ( )

inlineprotected

Definition at line 661 of file PaStiXSupport.h.

Member Data Documentation

m_iparm

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

mutableprotected

Definition at line 247 of file PaStiXSupport.h.

---

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

• PaStiXSupport.h