Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
SuperLU< _MatrixType > Class Template Reference
SuperLUSupport module

A sparse direct LU factorization and solver based on the SuperLU library. More...

#include <SuperLUSupport.h>

+ Inheritance diagram for SuperLU< _MatrixType >:

List of all members.

Public Types

typedef SuperLUBase
< _MatrixType, SuperLU > 		Base
typedef Base::Index Index
typedef Base::IntColVectorType IntColVectorType
typedef Base::IntRowVectorType IntRowVectorType
typedef TriangularView
< LUMatrixType, Lower|UnitDiag > 		LMatrixType
typedef Base::LUMatrixType LUMatrixType
typedef _MatrixType MatrixType
typedef Base::RealScalar RealScalar
typedef Base::Scalar Scalar
typedef TriangularView
< LUMatrixType, Upper > 		UMatrixType
typedef Matrix< Scalar,
Dynamic, 1 > 		Vector

Public Member Functions

void analyzePattern (const MatrixType &matrix)
Index cols () const
void compute (const MatrixType &matrix)
SuperLU< _MatrixType > & derived ()
const SuperLU< _MatrixType > & derived () const
Scalar determinant () const
void dumpMemory (Stream &s)
void factorize (const MatrixType &matrix)
ComputationInfo info () const
 Reports whether previous computation was successful.
const LMatrixType & matrixL () const
const UMatrixType & matrixU () const
superlu_options_t & options ()
const IntColVectorType & permutationP () const
const IntRowVectorType & permutationQ () const
Index rows () const
const internal::solve_retval
< SuperLUBase, Rhs > 		solve (const MatrixBase< Rhs > &b) const
 SuperLU ()
 SuperLU (const MatrixType &matrix)
 ~SuperLU ()

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>
class Eigen::SuperLU< _MatrixType >

A sparse direct LU factorization and solver based on the SuperLU library.

This class allows to solve for A.X = B sparse linear problems via a direct LU factorization using the SuperLU library. The sparse matrix A must be squared and invertible. The vectors or matrices X and B can be either dense or sparse.

Template Parameters:
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
See also:
Solving linear problems

Member Typedef Documentation

typedef SuperLUBase<_MatrixType,SuperLU> Base
typedef Base::Index Index

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef Base::IntColVectorType IntColVectorType

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef Base::IntRowVectorType IntRowVectorType

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef TriangularView<LUMatrixType, Lower|UnitDiag> LMatrixType
typedef Base::LUMatrixType LUMatrixType

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef _MatrixType MatrixType

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef Base::RealScalar RealScalar

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef Base::Scalar Scalar

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

typedef TriangularView<LUMatrixType, Upper> UMatrixType
typedef Matrix<Scalar,Dynamic,1> Vector
inherited

Constructor & Destructor Documentation

SuperLU ( )
inline

References SuperLU< _MatrixType >::init().

SuperLU ( const MatrixType &  matrix)
inline

References SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::compute(), and SuperLUBase< _MatrixType, Derived >::init().

~SuperLU ( )
inline

Member Function Documentation

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

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

References SuperLUBase< _MatrixType, Derived >::analyzePattern(), Eigen::InvalidInput, SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_info, and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_isInitialized.

void clearFactors ( )
inlineprotectedinherited
Index cols ( void  ) const
inlineinherited
void compute ( const MatrixType &  matrix)
inlineinherited

Computes the sparse Cholesky decomposition of matrix

Referenced by SuperLU< _MatrixType >::SuperLU().

SuperLU< _MatrixType > & derived ( )
inlineinherited
const SuperLU< _MatrixType > & derived ( ) const
inlineinherited
SuperLU< MatrixType >::Scalar determinant ( ) const

References eigen_assert.

void dumpMemory ( Stream &  s)
inlineinherited
void extractData ( ) const
protectedinherited

Referenced by SuperLU< _MatrixType >::matrixL(), SuperLU< _MatrixType >::matrixU(), SuperLU< _MatrixType >::permutationP(), and SuperLU< _MatrixType >::permutationQ().

void factorize ( const MatrixType &  matrix)

Performs a numeric decomposition of matrix

The given matrix must has the same sparcity than the matrix on which the symbolic decomposition has been performed.

See also:
analyzePattern()

References eigen_assert, Eigen::InvalidInput, Eigen::NumericalIssue, and Eigen::Success.

ComputationInfo info ( ) const
inlineinherited

Reports whether previous computation was successful.

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

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

References SuperLUBase< _MatrixType, Derived >::init(), and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_sluOptions.

Referenced by SuperLU< _MatrixType >::SuperLU().

void initFactorization ( const MatrixType &  a)
inlineprotectedinherited
const LMatrixType& matrixL ( ) const
inline

References SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::extractData(), SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_extractedDataAreDirty, and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_l.

const UMatrixType& matrixU ( ) const
inline

References SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::extractData(), SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_extractedDataAreDirty, and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_u.

superlu_options_t& options ( )
inlineinherited
Returns:
a reference to the Super LU option object to configure the Super LU algorithms.
const IntColVectorType& permutationP ( ) const
inline

References SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::extractData(), SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_extractedDataAreDirty, and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_p.

const IntRowVectorType& permutationQ ( ) const
inline

References SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::extractData(), SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_extractedDataAreDirty, and SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::m_q.

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

Member Data Documentation

int m_analysisIsOk
protectedinherited
bool m_extractedDataAreDirty
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::matrixL(), SuperLU< _MatrixType >::matrixU(), SuperLU< _MatrixType >::permutationP(), and SuperLU< _MatrixType >::permutationQ().

int m_factorizationIsOk
protectedinherited
ComputationInfo m_info
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::analyzePattern().

bool m_isInitialized
protectedinherited

Referenced by SuperLU< _MatrixType >::analyzePattern().

LUMatrixType m_l
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::matrixL().

LUMatrixType m_matrix
mutableprotectedinherited
IntColVectorType m_p
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::permutationP().

IntRowVectorType m_q
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::permutationQ().

SluMatrix m_sluA
mutableprotectedinherited
SluMatrix m_sluB
mutableprotectedinherited
Matrix<RealScalar,Dynamic,1> m_sluBerr
mutableprotectedinherited
Matrix<RealScalar,Dynamic,1> m_sluCscale
mutableprotectedinherited
char m_sluEqued
mutableprotectedinherited
std::vector<int> m_sluEtree
mutableprotectedinherited
Matrix<RealScalar,Dynamic,1> m_sluFerr
mutableprotectedinherited
SuperMatrix m_sluL
mutableprotectedinherited
superlu_options_t m_sluOptions
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::init().

Matrix<RealScalar,Dynamic,1> m_sluRscale
mutableprotectedinherited
SuperLUStat_t m_sluStat
mutableprotectedinherited
SuperMatrix m_sluU
mutableprotectedinherited
SluMatrix m_sluX
mutableprotectedinherited
LUMatrixType m_u
mutableprotectedinherited

Referenced by SuperLU< _MatrixType >::matrixU().

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