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 Matrix< int, MatrixType::RowsAtCompileTime, 1 >	IntColVectorType
typedef Matrix< int, 1, MatrixType::ColsAtCompileTime >	IntRowVectorType
typedef SparseMatrix< Scalar >	LUMatrixType
typedef _MatrixType	MatrixType
typedef Map< PermutationMatrix< Dynamic, Dynamic, int > >	PermutationMap
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::Scalar	Scalar
typedef MatrixType::StorageIndex	StorageIndex
typedef Matrix< Scalar, Dynamic, 1 >	Vector

Public Member Functions
void	analyzePattern (const MatrixType &)
Index	cols () const
void	compute (const MatrixType &matrix)
template<typename Stream >
void	dumpMemory (Stream &)
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
superlu_options_t &	options ()
Index	rows () const
	SuperLUBase ()
	~SuperLUBase ()
Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
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
	SparseSolverBase ()
	~SparseSolverBase ()

Protected Types
typedef SparseSolverBase< Derived >	Base

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

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

Private Member Functions
	SuperLUBase (SuperLUBase &)

Detailed Description

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

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

Definition at line 317 of file SuperLUSupport.h.

Member Typedef Documentation

template<typename _MatrixType, typename Derived>

typedef SparseSolverBase<Derived> Eigen::SuperLUBase< _MatrixType, Derived >::Base

protected

Definition at line 320 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> Eigen::SuperLUBase< _MatrixType, Derived >::IntColVectorType

Definition at line 330 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> Eigen::SuperLUBase< _MatrixType, Derived >::IntRowVectorType

Definition at line 329 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef SparseMatrix<Scalar> Eigen::SuperLUBase< _MatrixType, Derived >::LUMatrixType

Definition at line 332 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef _MatrixType Eigen::SuperLUBase< _MatrixType, Derived >::MatrixType

Definition at line 324 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef Map<PermutationMatrix<Dynamic,Dynamic,int> > Eigen::SuperLUBase< _MatrixType, Derived >::PermutationMap

Definition at line 331 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef MatrixType::RealScalar Eigen::SuperLUBase< _MatrixType, Derived >::RealScalar

Definition at line 326 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef MatrixType::Scalar Eigen::SuperLUBase< _MatrixType, Derived >::Scalar

Definition at line 325 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef MatrixType::StorageIndex Eigen::SuperLUBase< _MatrixType, Derived >::StorageIndex

Definition at line 327 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

typedef Matrix<Scalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::Vector

Definition at line 328 of file SuperLUSupport.h.

Member Enumeration Documentation

template<typename _MatrixType, typename Derived>

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime

Definition at line 333 of file SuperLUSupport.h.

Constructor & Destructor Documentation

template<typename _MatrixType, typename Derived>

Eigen::SuperLUBase< _MatrixType, Derived >::SuperLUBase ( )

inline

Definition at line 340 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Eigen::SuperLUBase< _MatrixType, Derived >::~SuperLUBase ( )

inline

Definition at line 342 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

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

inlineprivate

Definition at line 467 of file SuperLUSupport.h.

Member Function Documentation

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

Definition at line 377 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

void Eigen::SuperLUBase< _MatrixType, Derived >::clearFactors ( )

inlineprotected

Definition at line 430 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Index Eigen::SuperLUBase< _MatrixType, Derived >::cols ( void  ) const

inline

Definition at line 348 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

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

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 365 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

template<typename Stream >

void Eigen::SuperLUBase< _MatrixType, Derived >::dumpMemory ( Stream &  )

inline

Definition at line 386 of file SuperLUSupport.h.

template<typename MatrixType , typename Derived >

void Eigen::SuperLUBase< MatrixType, Derived >::extractData ( ) const

protected

Definition at line 707 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

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

inline

Reports whether previous computation was successful.

Returns

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

Definition at line 358 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

void Eigen::SuperLUBase< _MatrixType, Derived >::init ( )

inlineprotected

Definition at line 420 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

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

inlineprotected

Definition at line 391 of file SuperLUSupport.h.

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.

Definition at line 351 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Index Eigen::SuperLUBase< _MatrixType, Derived >::rows ( void  ) const

inline

Definition at line 347 of file SuperLUSupport.h.

Member Data Documentation

template<typename _MatrixType, typename Derived>

int Eigen::SuperLUBase< _MatrixType, Derived >::m_analysisIsOk

protected

Definition at line 463 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

bool Eigen::SuperLUBase< _MatrixType, Derived >::m_extractedDataAreDirty

mutableprotected

Definition at line 464 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

int Eigen::SuperLUBase< _MatrixType, Derived >::m_factorizationIsOk

protected

Definition at line 462 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

ComputationInfo Eigen::SuperLUBase< _MatrixType, Derived >::m_info

mutableprotected

Definition at line 461 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_l

mutableprotected

Definition at line 445 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_matrix

mutableprotected

Definition at line 450 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

IntColVectorType Eigen::SuperLUBase< _MatrixType, Derived >::m_p

mutableprotected

Definition at line 447 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

IntRowVectorType Eigen::SuperLUBase< _MatrixType, Derived >::m_q

mutableprotected

Definition at line 448 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluA

mutableprotected

Definition at line 451 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluB

mutableprotected

Definition at line 453 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluBerr

mutableprotected

Definition at line 458 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluCscale

mutableprotected

Definition at line 457 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

char Eigen::SuperLUBase< _MatrixType, Derived >::m_sluEqued

mutableprotected

Definition at line 459 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

std::vector<int> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluEtree

mutableprotected

Definition at line 456 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluFerr

mutableprotected

Definition at line 458 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SuperMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluL

mutableprotected

Definition at line 452 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

superlu_options_t Eigen::SuperLUBase< _MatrixType, Derived >::m_sluOptions

mutableprotected

Definition at line 455 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluRscale

mutableprotected

Definition at line 457 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SuperLUStat_t Eigen::SuperLUBase< _MatrixType, Derived >::m_sluStat

mutableprotected

Definition at line 454 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SuperMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluU

mutableprotected

Definition at line 452 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluX

mutableprotected

Definition at line 453 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>

LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_u

mutableprotected

Definition at line 446 of file SuperLUSupport.h.

---

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

• SuperLUSupport.h