Interface to the PaStix solver. More...

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixLU< _MatrixType, IsStrSym >:

Public Types
typedef _MatrixType	MatrixType

typedef PastixBase< PastixLU< MatrixType > >	Base

typedef Base::ColSpMatrix	ColSpMatrix

typedef MatrixType::StorageIndex	StorageIndex

Public Types inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
enum

typedef internal::pastix_traits< PastixLU< _MatrixType > >::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
	PastixLU (const MatrixType &matrix)

void	compute (const MatrixType &matrix)
	Compute the LU supernodal factorization of `matrix`.

void	analyzePattern (const MatrixType &matrix)
	Compute the LU symbolic factorization of `matrix` using its sparsity pattern.

void	factorize (const MatrixType &matrix)
	Compute the LU supernodal factorization of `matrix` WARNING The matrix `matrix` should have the same structural pattern as the same used in the analysis phase.

Public Member Functions inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
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< RealScalar, IPARM_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< PastixLU< _MatrixType > >
void	init ()
	Initialize the PaStiX data structure.

void	analyzePattern (ColSpMatrix &mat)

void	factorize (ColSpMatrix &mat)

void	clean ()

void	compute (ColSpMatrix &mat)

PastixLU< _MatrixType > &	derived ()

const PastixLU< _MatrixType > &	derived () const

Protected Attributes
ColSpMatrix	m_transposedStructure

bool	m_structureIsUptodate

Matrix< int, IPARM_SIZE, 1 >	m_iparm

Matrix< double, DPARM_SIZE, 1 >	m_dparm

Protected Attributes inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
int	m_initisOk

int	m_analysisIsOk

int	m_factorizationIsOk

ComputationInfo	m_info

pastix_data_t *	m_pastixdata

int	m_comm

Matrix< int, IPARM_SIZE, 1 >	m_iparm

Matrix< 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< PastixLU< _MatrixType > >
typedef SparseSolverBase< PastixLU< _MatrixType > >	Base

Detailed Description

template<typename _MatrixType, bool IsStrSym>
class Eigen::PastixLU< _MatrixType, IsStrSym >

Interface to the PaStix solver.

Sparse direct LU solver based on PaStiX library.

This class is used to solve the linear systems A.X = B via the PaStix library. The matrix can be either real or complex, symmetric or not.

See also: TutorialSparseDirectSolvers

This class is used to solve the linear systems A.X = B with a supernodal LU factorization in the PaStiX library. The matrix A should be squared and nonsingular PaStiX requires that the matrix A has a symmetric structural pattern. This interface can symmetrize the input matrix otherwise. 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<>
IsStrSym	Indicates if the input matrix has a symmetric pattern, default is false NOTE : Note that if the analysis and factorization phase are called separately, the input matrix will be symmetrized at each call, hence it is advised to symmetrize the matrix in a end-user program and set `IsStrSym` to true

\implsparsesolverconcept

See also: TutorialSparseDirectSolvers

Member Function Documentation

◆ analyzePattern()

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::analyzePattern ( const MatrixType & matrix )

inline

Compute the LU symbolic factorization of matrix using its sparsity pattern.

Several ordering methods can be used at this step. See the PaStiX user's manual. The result of this operation can be used with successive matrices having the same pattern as matrix

See also: factorize()

◆ compute()

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::compute ( const MatrixType & matrix )

inline

Compute the LU supernodal factorization of matrix.

iparm and dparm can be used to tune the PaStiX parameters. see the PaStiX user's manual

See also: analyzePattern() factorize()

◆ factorize()

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::factorize ( const MatrixType & matrix )

inline

Compute the LU supernodal factorization of matrix WARNING The matrix matrix should have the same structural pattern as the same used in the analysis phase.

See also: analyzePattern()

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

◆ factorize()