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 >:

Public Types
enum	{ UpLo = _UpLo }

typedef _MatrixType	MatrixType

typedef PastixBase< PastixLDLT< MatrixType, _UpLo > >	Base

typedef Base::ColSpMatrix	ColSpMatrix

Public Types inherited from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >
enum

typedef internal::pastix_traits< PastixLDLT< _MatrixType, _UpLo > >::MatrixType	_MatrixType

typedef _MatrixType	MatrixType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::StorageIndex	StorageIndex

typedef Matrix< Scalar, Dynamic, 1 >	Vector

typedef SparseMatrix< Scalar, ColMajor >	ColSpMatrix

Public Member Functions
	PastixLDLT (const MatrixType &matrix)

void	compute (const MatrixType &matrix)
	Compute the L and D factors of the LDL^T factorization of `matrix`.

void	analyzePattern (const MatrixType &matrix)
	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`.

void	factorize (const MatrixType &matrix)
	Compute the LDL^T supernodal numerical factorization of `matrix`.

Public Member Functions inherited from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >
bool	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const

void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Array< StorageIndex, IPARM_SIZE, 1 > &	iparm ()
	Returns a reference to the integer vector IPARM of PaStiX parameters to modify the default parameters.

int &	iparm (int idxparam)
	Return a reference to a particular index parameter of the IPARM vector.

Array< double, DPARM_SIZE, 1 > &	dparm ()
	Returns a reference to the double vector DPARM of PaStiX parameters The statistics related to the different phases of factorization and solve are saved here as well.

double &	dparm (int idxparam)
	Return a reference to a particular index parameter of the DPARM vector.

Index	cols () const

Index	rows () const

ComputationInfo	info () const
	Reports whether previous computation was successful.

Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	SparseSolverBase ()
	Default constructor.

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

template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Member Functions
void	init ()

void	grabMatrix (const MatrixType &matrix, ColSpMatrix &out)

Protected Member Functions inherited from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >
void	init ()
	Initialize the PaStiX data structure.

void	analyzePattern (ColSpMatrix &mat)

void	factorize (ColSpMatrix &mat)

void	clean ()

void	compute (ColSpMatrix &mat)

PastixLDLT< _MatrixType, _UpLo > &	derived ()

const PastixLDLT< _MatrixType, _UpLo > &	derived () const

Protected Attributes
Array< int, IPARM_SIZE, 1 >	m_iparm

Protected Attributes inherited from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >
int	m_initisOk

int	m_analysisIsOk

int	m_factorizationIsOk

ComputationInfo	m_info

pastix_data_t *	m_pastixdata

int	m_comm

Array< int, IPARM_SIZE, 1 >	m_iparm

Array< double, DPARM_SIZE, 1 >	m_dparm

Matrix< StorageIndex, Dynamic, 1 >	m_perm

Matrix< StorageIndex, Dynamic, 1 >	m_invp

int	m_size

bool	m_isInitialized

Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool	m_isInitialized

Additional Inherited Members
Protected Types inherited from Eigen::PastixBase< PastixLDLT< _MatrixType, _UpLo > >
typedef SparseSolverBase< PastixLDLT< _MatrixType, _UpLo > >	Base

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

\implsparsesolverconcept

See also: TutorialSparseSolverConcept, class SimplicialLDLT

Member Function Documentation

◆ analyzePattern()

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

◆ compute()

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

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

External/Eigen/src/PaStiXSupport/PaStiXSupport.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ analyzePattern()

◆ compute()