Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
SuperLUBase< _MatrixType, Derived > Class Template Reference
SuperLUSupport module

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

#include <SuperLUSupport.h>

Inherits noncopyable.

List of all members.

Public Types

typedef MatrixType::Index Index
typedef Matrix< int,
MatrixType::RowsAtCompileTime, 1 > 		IntColVectorType
typedef Matrix< int,
1, MatrixType::ColsAtCompileTime > 		IntRowVectorType
typedef SparseMatrix< Scalar > LUMatrixType
typedef _MatrixType MatrixType
typedef MatrixType::RealScalar RealScalar
typedef MatrixType::Scalar Scalar
typedef Matrix< Scalar,
Dynamic, 1 > 		Vector

Public Member Functions

void analyzePattern (const MatrixType &)
Index cols () const
void compute (const MatrixType &matrix)
Derived & derived ()
const Derived & derived () const
template<typename Stream >
void dumpMemory (Stream &s)
ComputationInfo info () const
 Reports whether previous computation was successful.
superlu_options_t & options ()
Index rows () const
template<typename Rhs >
const internal::solve_retval
< SuperLUBase, Rhs > 		solve (const MatrixBase< Rhs > &b) const
 SuperLUBase ()
 ~SuperLUBase ()

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
bool m_isInitialized
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

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 Typedef Documentation

typedef MatrixType::Index Index

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> IntColVectorType

Reimplemented in SuperLU< _MatrixType >.

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> IntRowVectorType

Reimplemented in SuperLU< _MatrixType >.

typedef SparseMatrix<Scalar> LUMatrixType

Reimplemented in SuperLU< _MatrixType >.

typedef _MatrixType MatrixType

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

typedef MatrixType::RealScalar RealScalar

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

typedef MatrixType::Scalar Scalar

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

typedef Matrix<Scalar,Dynamic,1> Vector

Constructor & Destructor Documentation

SuperLUBase ( )
inline
~SuperLUBase ( )
inline

Member Function Documentation

void analyzePattern ( const MatrixType &  )
inline
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute() 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()

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

Referenced by SuperLU< _MatrixType >::analyzePattern(), and SuperILU< _MatrixType >::analyzePattern().

void clearFactors ( )
inlineprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::~SuperLUBase().

Index cols ( void  ) const
inline
void compute ( const MatrixType &  matrix)
inline

Computes the sparse Cholesky decomposition of matrix

Derived& derived ( )
inline

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::compute().

const Derived& derived ( ) const
inline
void dumpMemory ( Stream &  s)
inline
void extractData ( ) const
protected

References eigen_assert.

ComputationInfo info ( ) const
inline

Reports whether previous computation was successful.

Returns:
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.
void init ( )
inlineprotected

Reimplemented in SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

Referenced by SuperLU< _MatrixType >::init(), SuperILU< _MatrixType >::init(), and SuperLU< _MatrixType >::SuperLU().

void initFactorization ( const MatrixType &  a)
inlineprotected
superlu_options_t& options ( )
inline
Returns:
a reference to the Super LU option object to configure the Super LU algorithms.
Index rows ( void  ) const
inline

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::solve().

const internal::solve_retval<SuperLUBase, Rhs> solve ( const MatrixBase< Rhs > &  b) const
inline
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()

Member Data Documentation

int m_analysisIsOk
protected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::analyzePattern().

bool m_extractedDataAreDirty
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

int m_factorizationIsOk
protected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::analyzePattern().

ComputationInfo m_info
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::analyzePattern(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::info(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::init().

bool m_isInitialized
protected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::analyzePattern(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::info(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::init(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::solve().

LUMatrixType m_l
mutableprotected
LUMatrixType m_matrix
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::cols(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::rows().

IntColVectorType m_p
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

IntRowVectorType m_q
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

SluMatrix m_sluA
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

SluMatrix m_sluB
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

Matrix<RealScalar,Dynamic,1> m_sluBerr
mutableprotected
Matrix<RealScalar,Dynamic,1> m_sluCscale
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

char m_sluEqued
mutableprotected
std::vector<int> m_sluEtree
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

Matrix<RealScalar,Dynamic,1> m_sluFerr
mutableprotected
SuperMatrix m_sluL
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::clearFactors(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::init().

superlu_options_t m_sluOptions
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::options().

Matrix<RealScalar,Dynamic,1> m_sluRscale
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

SuperLUStat_t m_sluStat
mutableprotected
SuperMatrix m_sluU
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::clearFactors(), and SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::init().

SluMatrix m_sluX
mutableprotected

Referenced by SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization().

LUMatrixType m_u
mutableprotected
The documentation for this class was generated from the following file:
Generated on Fri Jun 29 2012 20:20:12 for Eigen by   doxygen 1.8.1.1