Eigen::SuperLUBase< _MatrixType, Derived > Class Template Reference

The base class for the direct and incomplete LU factorization of SuperLU. More...

#include <SuperLUSupport.h>

Inheritance diagram for Eigen::SuperLUBase< _MatrixType, Derived >:

Public Types
enum	{ ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
typedef _MatrixType	MatrixType
typedef MatrixType::Scalar	Scalar
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::StorageIndex	StorageIndex
typedef Matrix< Scalar, Dynamic, 1 >	Vector
typedef Matrix< int, 1, MatrixType::ColsAtCompileTime >	IntRowVectorType
typedef Matrix< int, MatrixType::RowsAtCompileTime, 1 >	IntColVectorType
typedef Map< PermutationMatrix< Dynamic, Dynamic, int > >	PermutationMap
typedef SparseMatrix< Scalar >	LUMatrixType

Public Member Functions
Index	rows () const
Index	cols () const
superlu_options_t &	options ()
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
void	compute (const MatrixType &matrix)
void	analyzePattern (const MatrixType &)
template<typename Stream >
void	dumpMemory (Stream &)
Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	SparseSolverBase ()
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 Types
typedef SparseSolverBase< Derived >	Base

Protected Member Functions
void	initFactorization (const MatrixType &a)
void	init ()
void	extractData () const
void	clearFactors ()
Derived &	derived ()
const Derived &	derived () const

Protected Attributes
LUMatrixType	m_l
LUMatrixType	m_u
IntColVectorType	m_p
IntRowVectorType	m_q
LUMatrixType	m_matrix
SluMatrix	m_sluA
SuperMatrix	m_sluL
SuperMatrix	m_sluU
SluMatrix	m_sluB
SluMatrix	m_sluX
SuperLUStat_t	m_sluStat
superlu_options_t	m_sluOptions
std::vector< int >	m_sluEtree
Matrix< RealScalar, Dynamic, 1 >	m_sluRscale
Matrix< RealScalar, Dynamic, 1 >	m_sluCscale
Matrix< RealScalar, Dynamic, 1 >	m_sluFerr
Matrix< RealScalar, Dynamic, 1 >	m_sluBerr
char	m_sluEqued
ComputationInfo	m_info
int	m_factorizationIsOk
int	m_analysisIsOk
bool	m_extractedDataAreDirty
bool	m_isInitialized
Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool	m_isInitialized

Detailed Description

template<typename _MatrixType, typename Derived>
class Eigen::SuperLUBase< _MatrixType, Derived >

The base class for the direct and incomplete LU factorization of SuperLU.

Member Function Documentation

analyzePattern()

template<typename _MatrixType , typename Derived >

void Eigen::SuperLUBase< _MatrixType, Derived >::analyzePattern ( const MatrixType &  )

inline

Performs a symbolic decomposition on the sparcity of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also

factorize()

compute()

template<typename _MatrixType , typename Derived >

void Eigen::SuperLUBase< _MatrixType, Derived >::compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

info()

template<typename _MatrixType , typename Derived >

ComputationInfo Eigen::SuperLUBase< _MatrixType, Derived >::info ( ) const

inline

Reports whether previous computation was successful.

Returns

Success if computation was successful, NumericalIssue if the matrix.appears to be negative.

options()

template<typename _MatrixType , typename Derived >

superlu_options_t& Eigen::SuperLUBase< _MatrixType, Derived >::options ( )

inline

Returns

a reference to the Super LU option object to configure the Super LU algorithms.

---

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

• SuperLUSupport.h