Eigen::PastixLDLT< _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::PastixLDLT< _MatrixType, _UpLo >:

List of all members.

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

---

Detailed Description

template<typename _MatrixType, int _UpLo>
class Eigen::PastixLDLT< _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 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

See also:

TutorialSparseDirectSolvers

Definition at line 643 of file PaStiXSupport.h.

---

Member Typedef Documentation

template<typename _MatrixType , int _UpLo>

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

Definition at line 647 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

typedef Base::ColSpMatrix Eigen::PastixLDLT< _MatrixType, _UpLo >::ColSpMatrix

Reimplemented from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >.

Definition at line 648 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

typedef _MatrixType Eigen::PastixLDLT< _MatrixType, _UpLo >::MatrixType

Reimplemented from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >.

Definition at line 646 of file PaStiXSupport.h.

---

Member Enumeration Documentation

template<typename _MatrixType , int _UpLo>

anonymous enum

Enumerator:

UpLo

Definition at line 651 of file PaStiXSupport.h.

---

Constructor & Destructor Documentation

template<typename _MatrixType , int _UpLo>

Eigen::PastixLDLT< _MatrixType, _UpLo >::PastixLDLT

(

)

[inline]

Definition at line 652 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

Eigen::PastixLDLT< _MatrixType, _UpLo >::PastixLDLT

(

const MatrixType &

matrix

)

[inline]

Definition at line 657 of file PaStiXSupport.h.

---

Member Function Documentation

template<typename _MatrixType , int _UpLo>

void Eigen::PastixLDLT< _MatrixType, _UpLo >::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 677 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

void Eigen::PastixLDLT< _MatrixType, _UpLo >::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 666 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

void Eigen::PastixLDLT< _MatrixType, _UpLo >::factorize

(

const MatrixType &

matrix

)

[inline]

Compute the LDL^T supernodal numerical factorization of matrix

Definition at line 686 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

void Eigen::PastixLDLT< _MatrixType, _UpLo >::grabMatrix	(	const MatrixType &	matrix,
		ColSpMatrix &	out
	)		[inline, protected]

Definition at line 702 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>

void Eigen::PastixLDLT< _MatrixType, _UpLo >::init

(

)

[inline, protected]

Reimplemented from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >.

Definition at line 696 of file PaStiXSupport.h.

---

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

• PaStiXSupport.h