Eigen::PastixLLT 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< PastixLLT< 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)
	PastixLLT ()
	PastixLLT (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 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

Definition at line 32 of file PaStiXSupport.h.

Member Typedef Documentation

Base

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

Definition at line 528 of file PaStiXSupport.h.

ColSpMatrix

typedef Base::ColSpMatrix Eigen::PastixLLT::ColSpMatrix

Definition at line 529 of file PaStiXSupport.h.

MatrixType

typedef _MatrixType Eigen::PastixLLT::MatrixType

Definition at line 527 of file PaStiXSupport.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UpLo

Definition at line 532 of file PaStiXSupport.h.

Constructor & Destructor Documentation

PastixLLT() [1/2]

Eigen::PastixLLT::PastixLLT ( )

inline

Definition at line 533 of file PaStiXSupport.h.

PastixLLT() [2/2]

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

inlineexplicit

Definition at line 538 of file PaStiXSupport.h.

Member Function Documentation

analyzePattern()

void Eigen::PastixLLT::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 558 of file PaStiXSupport.h.

compute()

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

inline

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

See also

analyzePattern() factorize()

Definition at line 547 of file PaStiXSupport.h.

factorize()

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

inline

Compute the LL^T supernodal numerical factorization of matrix

See also

analyzePattern()

Definition at line 567 of file PaStiXSupport.h.

grabMatrix()

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

inlineprotected

Definition at line 582 of file PaStiXSupport.h.

init()

void Eigen::PastixLLT::init ( )

inlineprotected

Definition at line 576 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