Public Types | Public Member Functions | Protected Member Functions
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 >:
Inheritance graph
[legend]

List of all members.

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

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:
MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
UpLoThe part of the matrix to use : Lower or Upper. The default is Lower as required by PaStiX
See also:
TutorialSparseDirectSolvers

Definition at line 562 of file PaStiXSupport.h.


Member Typedef Documentation

template<typename _MatrixType , int _UpLo>
typedef PastixBase<PastixLLT<MatrixType, _UpLo> > Eigen::PastixLLT< _MatrixType, _UpLo >::Base

Definition at line 566 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>
typedef Base::ColSpMatrix Eigen::PastixLLT< _MatrixType, _UpLo >::ColSpMatrix

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

Definition at line 567 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>
typedef _MatrixType Eigen::PastixLLT< _MatrixType, _UpLo >::MatrixType

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

Definition at line 565 of file PaStiXSupport.h.


Member Enumeration Documentation

template<typename _MatrixType , int _UpLo>
anonymous enum
Enumerator:
UpLo 

Definition at line 570 of file PaStiXSupport.h.


Constructor & Destructor Documentation

template<typename _MatrixType , int _UpLo>
Eigen::PastixLLT< _MatrixType, _UpLo >::PastixLLT ( ) [inline]

Definition at line 571 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>
Eigen::PastixLLT< _MatrixType, _UpLo >::PastixLLT ( const MatrixType matrix) [inline]

Definition at line 576 of file PaStiXSupport.h.


Member Function Documentation

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 596 of file PaStiXSupport.h.

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 585 of file PaStiXSupport.h.

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 605 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::grabMatrix ( const MatrixType matrix,
ColSpMatrix out 
) [inline, protected]

Definition at line 620 of file PaStiXSupport.h.

template<typename _MatrixType , int _UpLo>
void Eigen::PastixLLT< _MatrixType, _UpLo >::init ( ) [inline, protected]

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

Definition at line 614 of file PaStiXSupport.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:17