SparseLU< MatrixType, UmfPack > Class Template Reference

#include <UmfPackSupport.h>

Inheritance diagram for SparseLU< MatrixType, UmfPack >:

[legend]

List of all members.

Public Member Functions
void	compute (const MatrixType &matrix)
Scalar	determinant () const
const LMatrixType &	matrixL () const
const UMatrixType &	matrixU () const
const IntColVectorType &	permutationP () const
const IntRowVectorType &	permutationQ () const
template<typename BDerived , typename XDerived >
bool	solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > *x) const
	SparseLU (const MatrixType &matrix, int flags=NaturalOrdering)
	SparseLU (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, LowerTriangular|UnitDiagBit >	LMatrixType
typedef Base::RealScalar	RealScalar
typedef Base::Scalar	Scalar
typedef SparseMatrix< Scalar, UpperTriangular >	UMatrixType
typedef Matrix< Scalar, Dynamic, 1 >	Vector
Protected Member Functions
void	extractData () const
Protected Attributes
bool	m_extractedDataAreDirty
LMatrixType	m_l
const MatrixType *	m_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 121 of file UmfPackSupport.h.

---

Member Typedef Documentation

template<typename MatrixType >

typedef SparseLU<MatrixType> SparseLU< MatrixType, UmfPack >::Base [protected]

Definition at line 124 of file UmfPackSupport.h.

template<typename MatrixType >

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> SparseLU< MatrixType, UmfPack >::IntColVectorType [protected]

Definition at line 129 of file UmfPackSupport.h.

template<typename MatrixType >

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> SparseLU< MatrixType, UmfPack >::IntRowVectorType [protected]

Definition at line 128 of file UmfPackSupport.h.

template<typename MatrixType >

typedef SparseMatrix<Scalar,LowerTriangular|UnitDiagBit> SparseLU< MatrixType, UmfPack >::LMatrixType [protected]

Definition at line 130 of file UmfPackSupport.h.

template<typename MatrixType >

typedef Base::RealScalar SparseLU< MatrixType, UmfPack >::RealScalar [protected]

Reimplemented from SparseLU< MatrixType >.

Definition at line 126 of file UmfPackSupport.h.

template<typename MatrixType >

typedef Base::Scalar SparseLU< MatrixType, UmfPack >::Scalar [protected]

Reimplemented from SparseLU< MatrixType >.

Definition at line 125 of file UmfPackSupport.h.

template<typename MatrixType >

typedef SparseMatrix<Scalar,UpperTriangular> SparseLU< MatrixType, UmfPack >::UMatrixType [protected]

Definition at line 131 of file UmfPackSupport.h.

template<typename MatrixType >

typedef Matrix<Scalar,Dynamic,1> SparseLU< MatrixType, UmfPack >::Vector [protected]

Definition at line 127 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 137 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 142 of file UmfPackSupport.h.

template<typename MatrixType >

SparseLU< MatrixType, UmfPack >::~SparseLU

(

)

[inline]

Definition at line 148 of file UmfPackSupport.h.

---

Member Function Documentation

template<typename MatrixType >

void SparseLU< MatrixType, UmfPack >::compute

(

const MatrixType &

matrix

)

[inline]

Computes/re-computes the LU factorization

Reimplemented from SparseLU< MatrixType >.

Definition at line 201 of file UmfPackSupport.h.

template<typename MatrixType >

SparseLU< MatrixType, UmfPack >::Scalar SparseLU< MatrixType, UmfPack >::determinant

(

)

const [inline]

Definition at line 256 of file UmfPackSupport.h.

template<typename MatrixType >

void SparseLU< MatrixType, UmfPack >::extractData

(

)

const [inline, protected]

Definition at line 228 of file UmfPackSupport.h.

template<typename MatrixType >

const LMatrixType& SparseLU< MatrixType, UmfPack >::matrixL

(

void

)

const [inline]

Definition at line 154 of file UmfPackSupport.h.

template<typename MatrixType >

const UMatrixType& SparseLU< MatrixType, UmfPack >::matrixU

(

)

const [inline]

Definition at line 160 of file UmfPackSupport.h.

template<typename MatrixType >

const IntColVectorType& SparseLU< MatrixType, UmfPack >::permutationP

(

)

const [inline]

Definition at line 166 of file UmfPackSupport.h.

template<typename MatrixType >

const IntRowVectorType& SparseLU< MatrixType, UmfPack >::permutationQ

(

)

const [inline]

Definition at line 172 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 [inline]

Returns:

the lower triangular matrix L

the upper triangular matrix U

Reimplemented from SparseLU< MatrixType >.

Definition at line 265 of file UmfPackSupport.h.

---

Member Data Documentation

template<typename MatrixType >

bool SparseLU< MatrixType, UmfPack >::m_extractedDataAreDirty [mutable, protected]

Definition at line 197 of file UmfPackSupport.h.

template<typename MatrixType >

LMatrixType SparseLU< MatrixType, UmfPack >::m_l [mutable, protected]

Definition at line 193 of file UmfPackSupport.h.

template<typename MatrixType >

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

Definition at line 192 of file UmfPackSupport.h.

template<typename MatrixType >

void* SparseLU< MatrixType, UmfPack >::m_numeric [protected]

Definition at line 191 of file UmfPackSupport.h.

template<typename MatrixType >

IntColVectorType SparseLU< MatrixType, UmfPack >::m_p [mutable, protected]

Definition at line 195 of file UmfPackSupport.h.

template<typename MatrixType >

IntRowVectorType SparseLU< MatrixType, UmfPack >::m_q [mutable, protected]

Definition at line 196 of file UmfPackSupport.h.

template<typename MatrixType >

UMatrixType SparseLU< MatrixType, UmfPack >::m_u [mutable, protected]

Definition at line 194 of file UmfPackSupport.h.

---

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

• UmfPackSupport.h