Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
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 >:
Inheritance graph
[legend]

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< ScalarLUMatrixType
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 &)
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
template<typename Rhs >
const
internal::sparse_solve_retval
< SuperLUBase, Rhs > 
solve (const SparseMatrixBase< 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

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 291 of file SuperLUSupport.h.


Member Typedef Documentation

template<typename _MatrixType, typename Derived>
typedef MatrixType::Index Eigen::SuperLUBase< _MatrixType, Derived >::Index

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 297 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 300 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 299 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 301 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 294 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 296 of file SuperLUSupport.h.

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

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 295 of file SuperLUSupport.h.

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

Definition at line 298 of file SuperLUSupport.h.


Constructor & Destructor Documentation

template<typename _MatrixType, typename Derived>
Eigen::SuperLUBase< _MatrixType, Derived >::SuperLUBase ( ) [inline]

Definition at line 305 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Eigen::SuperLUBase< _MatrixType, Derived >::~SuperLUBase ( ) [inline]

Definition at line 307 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Eigen::SuperLUBase< _MatrixType, Derived >::SuperLUBase ( SuperLUBase< _MatrixType, Derived > &  ) [inline, private]

Definition at line 462 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()

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 371 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
void Eigen::SuperLUBase< _MatrixType, Derived >::clearFactors ( ) [inline, protected]

Definition at line 424 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Index Eigen::SuperLUBase< _MatrixType, Derived >::cols ( void  ) const [inline]

Definition at line 316 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 333 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Derived& Eigen::SuperLUBase< _MatrixType, Derived >::derived ( ) [inline]

Definition at line 312 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
const Derived& Eigen::SuperLUBase< _MatrixType, Derived >::derived ( ) const [inline]

Definition at line 313 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
template<typename Stream >
void Eigen::SuperLUBase< _MatrixType, Derived >::dumpMemory ( Stream &  ) [inline]

Definition at line 380 of file SuperLUSupport.h.

template<typename MatrixType , typename Derived >
void Eigen::SuperLUBase< MatrixType, Derived >::extractData ( ) const [protected]

Definition at line 690 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 326 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
void Eigen::SuperLUBase< _MatrixType, Derived >::init ( ) [inline, protected]

Reimplemented in Eigen::SuperLU< _MatrixType >.

Definition at line 414 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
void Eigen::SuperLUBase< _MatrixType, Derived >::initFactorization ( const MatrixType a) [inline, protected]

Definition at line 385 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 319 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Index Eigen::SuperLUBase< _MatrixType, Derived >::rows ( void  ) const [inline]

Definition at line 315 of file SuperLUSupport.h.

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

Definition at line 344 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
template<typename Rhs >
const internal::sparse_solve_retval<SuperLUBase, Rhs> Eigen::SuperLUBase< _MatrixType, Derived >::solve ( const SparseMatrixBase< Rhs > &  b) const [inline]
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()

Definition at line 357 of file SuperLUSupport.h.


Member Data Documentation

template<typename _MatrixType, typename Derived>
int Eigen::SuperLUBase< _MatrixType, Derived >::m_analysisIsOk [protected]

Definition at line 458 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
bool Eigen::SuperLUBase< _MatrixType, Derived >::m_extractedDataAreDirty [mutable, protected]

Definition at line 459 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
int Eigen::SuperLUBase< _MatrixType, Derived >::m_factorizationIsOk [protected]

Definition at line 457 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
ComputationInfo Eigen::SuperLUBase< _MatrixType, Derived >::m_info [mutable, protected]

Definition at line 455 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
bool Eigen::SuperLUBase< _MatrixType, Derived >::m_isInitialized [protected]

Definition at line 456 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_l [mutable, protected]

Definition at line 439 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_matrix [mutable, protected]

Definition at line 444 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
IntColVectorType Eigen::SuperLUBase< _MatrixType, Derived >::m_p [mutable, protected]

Definition at line 441 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
IntRowVectorType Eigen::SuperLUBase< _MatrixType, Derived >::m_q [mutable, protected]

Definition at line 442 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluA [mutable, protected]

Definition at line 445 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluB [mutable, protected]

Definition at line 447 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluBerr [mutable, protected]

Definition at line 452 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluCscale [mutable, protected]

Definition at line 451 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
char Eigen::SuperLUBase< _MatrixType, Derived >::m_sluEqued [mutable, protected]

Definition at line 453 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
std::vector<int> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluEtree [mutable, protected]

Definition at line 450 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluFerr [mutable, protected]

Definition at line 452 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SuperMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluL [mutable, protected]

Definition at line 446 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
superlu_options_t Eigen::SuperLUBase< _MatrixType, Derived >::m_sluOptions [mutable, protected]

Definition at line 449 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< _MatrixType, Derived >::m_sluRscale [mutable, protected]

Definition at line 451 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SuperLUStat_t Eigen::SuperLUBase< _MatrixType, Derived >::m_sluStat [mutable, protected]

Definition at line 448 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SuperMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluU [mutable, protected]

Definition at line 446 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
SluMatrix Eigen::SuperLUBase< _MatrixType, Derived >::m_sluX [mutable, protected]

Definition at line 447 of file SuperLUSupport.h.

template<typename _MatrixType, typename Derived>
LUMatrixType Eigen::SuperLUBase< _MatrixType, Derived >::m_u [mutable, protected]

Definition at line 440 of file SuperLUSupport.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 12:02:04