Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
SparseLU< _MatrixType, UmfPack > Class Template Reference

#include <UmfPackSupport.h>

Inheritance diagram for SparseLU< _MatrixType, UmfPack >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef MatrixType::Index Index
typedef _MatrixType MatrixType

Public Member Functions

Index cols () const
void compute (const MatrixType &matrix)
Scalar determinant () const
const LMatrixTypematrixL () const
const MatrixTypematrixLU () const
const UMatrixTypematrixU () const
const void * numeric () const
const IntColVectorTypepermutationP () const
const IntRowVectorTypepermutationQ () const
Index rows () const
template<typename BDerived , typename XDerived >
bool solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > *x) const
template<typename Rhs >
const internal::solve_retval
< SparseLU< MatrixType,
UmfPack >, Rhs > 
solve (const MatrixBase< Rhs > &b) const
 SparseLU (int flags=NaturalOrdering)
 SparseLU (const MatrixType &matrix, int flags=NaturalOrdering)
 ~SparseLU ()

Protected Types

typedef SparseLU< _MatrixType > Base
typedef Matrix< int,
_MatrixType::RowsAtCompileTime, 1 > 
IntColVectorType
typedef Matrix< int,
1, _MatrixType::ColsAtCompileTime > 
IntRowVectorType
typedef SparseMatrix< Scalar,
Lower|UnitDiag
LMatrixType
typedef Base::RealScalar RealScalar
typedef Base::Scalar Scalar
typedef SparseMatrix< Scalar,
Upper
UMatrixType
typedef Matrix< Scalar,
Dynamic, 1 > 
Vector

Protected Member Functions

void extractData () const

Protected Attributes

bool m_extractedDataAreDirty
LMatrixType m_l
const MatrixTypem_matrixRef
void * m_numeric
IntColVectorType m_p
IntRowVectorType m_q
UMatrixType m_u

Detailed Description

template<typename _MatrixType>
class SparseLU< _MatrixType, UmfPack >

Definition at line 125 of file UmfPackSupport.h.


Member Typedef Documentation

template<typename _MatrixType >
typedef SparseLU<_MatrixType> SparseLU< _MatrixType, UmfPack >::Base [protected]

Definition at line 128 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef MatrixType::Index SparseLU< _MatrixType, UmfPack >::Index

Definition at line 141 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef Matrix<int, _MatrixType::RowsAtCompileTime, 1> SparseLU< _MatrixType, UmfPack >::IntColVectorType [protected]

Definition at line 133 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef Matrix<int, 1, _MatrixType::ColsAtCompileTime> SparseLU< _MatrixType, UmfPack >::IntRowVectorType [protected]

Definition at line 132 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef SparseMatrix<Scalar,Lower|UnitDiag> SparseLU< _MatrixType, UmfPack >::LMatrixType [protected]

Definition at line 134 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef _MatrixType SparseLU< _MatrixType, UmfPack >::MatrixType

Reimplemented from SparseLU< _MatrixType >.

Definition at line 140 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef Base::RealScalar SparseLU< _MatrixType, UmfPack >::RealScalar [protected]

Reimplemented from SparseLU< _MatrixType >.

Definition at line 130 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef Base::Scalar SparseLU< _MatrixType, UmfPack >::Scalar [protected]

Reimplemented from SparseLU< _MatrixType >.

Definition at line 129 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef SparseMatrix<Scalar,Upper> SparseLU< _MatrixType, UmfPack >::UMatrixType [protected]

Definition at line 135 of file UmfPackSupport.h.

template<typename _MatrixType >
typedef Matrix<Scalar,Dynamic,1> SparseLU< _MatrixType, UmfPack >::Vector [protected]

Definition at line 131 of file UmfPackSupport.h.


Constructor & Destructor Documentation

template<typename _MatrixType >
SparseLU< _MatrixType, UmfPack >::SparseLU ( int  flags = NaturalOrdering) [inline]

Creates a dummy LU factorization object with flags flags.

Reimplemented from SparseLU< _MatrixType >.

Definition at line 143 of file UmfPackSupport.h.

template<typename _MatrixType >
SparseLU< _MatrixType, UmfPack >::SparseLU ( const MatrixType matrix,
int  flags = NaturalOrdering 
) [inline]

Creates a LU object and compute the respective factorization of matrix using flags flags.

Reimplemented from SparseLU< _MatrixType >.

Definition at line 148 of file UmfPackSupport.h.

template<typename _MatrixType >
SparseLU< _MatrixType, UmfPack >::~SparseLU ( ) [inline]

Definition at line 154 of file UmfPackSupport.h.


Member Function Documentation

template<typename _MatrixType >
Index SparseLU< _MatrixType, UmfPack >::cols ( void  ) const [inline]

Definition at line 199 of file UmfPackSupport.h.

template<typename _MatrixType >
void SparseLU< _MatrixType, UmfPack >::compute ( const MatrixType matrix)

Computes/re-computes the LU factorization

Reimplemented from SparseLU< _MatrixType >.

template<typename _MatrixType >
Scalar SparseLU< _MatrixType, UmfPack >::determinant ( ) const
template<typename _MatrixType >
void SparseLU< _MatrixType, UmfPack >::extractData ( ) const [protected]
template<typename _MatrixType >
const LMatrixType& SparseLU< _MatrixType, UmfPack >::matrixL ( void  ) const [inline]

Definition at line 160 of file UmfPackSupport.h.

template<typename _MatrixType >
const MatrixType& SparseLU< _MatrixType, UmfPack >::matrixLU ( ) const [inline]

Definition at line 202 of file UmfPackSupport.h.

template<typename _MatrixType >
const UMatrixType& SparseLU< _MatrixType, UmfPack >::matrixU ( ) const [inline]

Definition at line 166 of file UmfPackSupport.h.

template<typename _MatrixType >
const void* SparseLU< _MatrixType, UmfPack >::numeric ( ) const [inline]

Definition at line 208 of file UmfPackSupport.h.

template<typename _MatrixType >
const IntColVectorType& SparseLU< _MatrixType, UmfPack >::permutationP ( ) const [inline]

Definition at line 172 of file UmfPackSupport.h.

template<typename _MatrixType >
const IntRowVectorType& SparseLU< _MatrixType, UmfPack >::permutationQ ( ) const [inline]

Definition at line 178 of file UmfPackSupport.h.

template<typename _MatrixType >
Index SparseLU< _MatrixType, UmfPack >::rows ( void  ) const [inline]

Definition at line 200 of file UmfPackSupport.h.

template<typename _MatrixType >
template<typename BDerived , typename XDerived >
bool SparseLU< _MatrixType, UmfPack >::solve ( const MatrixBase< BDerived > &  b,
MatrixBase< XDerived > *  x 
) const
template<typename _MatrixType >
template<typename Rhs >
const internal::solve_retval<SparseLU<MatrixType, UmfPack>, Rhs> SparseLU< _MatrixType, UmfPack >::solve ( const MatrixBase< Rhs > &  b) const [inline]

Definition at line 191 of file UmfPackSupport.h.


Member Data Documentation

template<typename _MatrixType >
bool SparseLU< _MatrixType, UmfPack >::m_extractedDataAreDirty [mutable, protected]

Definition at line 225 of file UmfPackSupport.h.

template<typename _MatrixType >
LMatrixType SparseLU< _MatrixType, UmfPack >::m_l [mutable, protected]

Definition at line 221 of file UmfPackSupport.h.

template<typename _MatrixType >
const MatrixType* SparseLU< _MatrixType, UmfPack >::m_matrixRef [protected]

Definition at line 220 of file UmfPackSupport.h.

template<typename _MatrixType >
void* SparseLU< _MatrixType, UmfPack >::m_numeric [protected]

Definition at line 219 of file UmfPackSupport.h.

template<typename _MatrixType >
IntColVectorType SparseLU< _MatrixType, UmfPack >::m_p [mutable, protected]

Definition at line 223 of file UmfPackSupport.h.

template<typename _MatrixType >
IntRowVectorType SparseLU< _MatrixType, UmfPack >::m_q [mutable, protected]

Definition at line 224 of file UmfPackSupport.h.

template<typename _MatrixType >
UMatrixType SparseLU< _MatrixType, UmfPack >::m_u [mutable, protected]

Definition at line 222 of file UmfPackSupport.h.


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


re_vision
Author(s): Dorian Galvez-Lopez
autogenerated on Sun Jan 5 2014 11:34:25