SparseLU< MatrixType, SuperLU > Class Template Reference

#include <SuperLUSupport.h>

Inheritance diagram for SparseLU< MatrixType, SuperLU >:

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 int transposed=SvNoTrans) 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
SparseMatrix< Scalar >	m_matrix
IntColVectorType	m_p
IntRowVectorType	m_q
SluMatrix	m_sluA
SluMatrix	m_sluB
std::vector< RealScalar >	m_sluBerr
std::vector< RealScalar >	m_sluCscale
char	m_sluEqued
std::vector< int >	m_sluEtree
std::vector< RealScalar >	m_sluFerr
SuperMatrix	m_sluL
superlu_options_t	m_sluOptions
std::vector< RealScalar >	m_sluRscale
SuperLUStat_t	m_sluStat
SuperMatrix	m_sluU
SluMatrix	m_sluX
UMatrixType	m_u

---

Detailed Description

template<typename MatrixType>
class SparseLU< MatrixType, SuperLU >

Definition at line 299 of file SuperLUSupport.h.

---

Member Typedef Documentation

template<typename MatrixType >

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

Definition at line 302 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 307 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 306 of file SuperLUSupport.h.

template<typename MatrixType >

typedef SparseMatrix<Scalar,Lower|UnitDiag> SparseLU< MatrixType, SuperLU >::LMatrixType [protected]

Definition at line 308 of file SuperLUSupport.h.

template<typename MatrixType >

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

Reimplemented from SparseLU< MatrixType >.

Definition at line 304 of file SuperLUSupport.h.

template<typename MatrixType >

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

Reimplemented from SparseLU< MatrixType >.

Definition at line 303 of file SuperLUSupport.h.

template<typename MatrixType >

typedef SparseMatrix<Scalar,Upper> SparseLU< MatrixType, SuperLU >::UMatrixType [protected]

Definition at line 309 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 305 of file SuperLUSupport.h.

---

Constructor & Destructor Documentation

template<typename MatrixType >

SparseLU< MatrixType, SuperLU >::SparseLU

(

int

flags = NaturalOrdering

)

[inline]

Creates a dummy LU factorization object with flags flags.

Reimplemented from SparseLU< MatrixType >.

Definition at line 315 of file SuperLUSupport.h.

template<typename MatrixType >

SparseLU< MatrixType, SuperLU >::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 320 of file SuperLUSupport.h.

template<typename MatrixType >

SparseLU< MatrixType, SuperLU >::~SparseLU

(

)

[inline]

Definition at line 326 of file SuperLUSupport.h.

---

Member Function Documentation

template<typename MatrixType >

void SparseLU< MatrixType, SuperLU >::compute

(

const MatrixType &

matrix

)

Computes/re-computes the LU factorization

Reimplemented from SparseLU< MatrixType >.

Definition at line 388 of file SuperLUSupport.h.

template<typename MatrixType >

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

(

)

const

Definition at line 642 of file SuperLUSupport.h.

template<typename MatrixType >

void SparseLU< MatrixType, SuperLU >::extractData

(

)

const [protected]

Definition at line 557 of file SuperLUSupport.h.

template<typename MatrixType >

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

(

void

)

const [inline]

Definition at line 332 of file SuperLUSupport.h.

template<typename MatrixType >

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

(

)

const [inline]

Definition at line 338 of file SuperLUSupport.h.

template<typename MatrixType >

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

(

)

const [inline]

Definition at line 344 of file SuperLUSupport.h.

template<typename MatrixType >

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

(

)

const [inline]

Definition at line 350 of file SuperLUSupport.h.

template<typename MatrixType >

template<typename BDerived , typename XDerived >

bool SparseLU< MatrixType, SuperLU >::solve	(	const MatrixBase< BDerived > &	b,
		MatrixBase< XDerived > *	x,
		const int	transposed = SvNoTrans
	)		const

Returns:

the lower triangular matrix L

the upper triangular matrix U

Reimplemented from SparseLU< MatrixType >.

Definition at line 484 of file SuperLUSupport.h.

---

Member Data Documentation

template<typename MatrixType >

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

Definition at line 384 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 369 of file SuperLUSupport.h.

template<typename MatrixType >

SparseMatrix<Scalar> SparseLU< MatrixType, SuperLU >::m_matrix [mutable, protected]

Definition at line 374 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 371 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 372 of file SuperLUSupport.h.

template<typename MatrixType >

SluMatrix SparseLU< MatrixType, SuperLU >::m_sluA [mutable, protected]

Definition at line 375 of file SuperLUSupport.h.

template<typename MatrixType >

SluMatrix SparseLU< MatrixType, SuperLU >::m_sluB [mutable, protected]

Definition at line 377 of file SuperLUSupport.h.

template<typename MatrixType >

std::vector<RealScalar> SparseLU< MatrixType, SuperLU >::m_sluBerr [mutable, protected]

Definition at line 382 of file SuperLUSupport.h.

template<typename MatrixType >

std::vector<RealScalar> SparseLU< MatrixType, SuperLU >::m_sluCscale [mutable, protected]

Definition at line 381 of file SuperLUSupport.h.

template<typename MatrixType >

char SparseLU< MatrixType, SuperLU >::m_sluEqued [mutable, protected]

Definition at line 383 of file SuperLUSupport.h.

template<typename MatrixType >

std::vector<int> SparseLU< MatrixType, SuperLU >::m_sluEtree [mutable, protected]

Definition at line 380 of file SuperLUSupport.h.

template<typename MatrixType >

std::vector<RealScalar> SparseLU< MatrixType, SuperLU >::m_sluFerr [mutable, protected]

Definition at line 382 of file SuperLUSupport.h.

template<typename MatrixType >

SuperMatrix SparseLU< MatrixType, SuperLU >::m_sluL [mutable, protected]

Definition at line 376 of file SuperLUSupport.h.

template<typename MatrixType >

superlu_options_t SparseLU< MatrixType, SuperLU >::m_sluOptions [mutable, protected]

Definition at line 379 of file SuperLUSupport.h.

template<typename MatrixType >

std::vector<RealScalar> SparseLU< MatrixType, SuperLU >::m_sluRscale [mutable, protected]

Definition at line 381 of file SuperLUSupport.h.

template<typename MatrixType >

SuperLUStat_t SparseLU< MatrixType, SuperLU >::m_sluStat [mutable, protected]

Definition at line 378 of file SuperLUSupport.h.

template<typename MatrixType >

SuperMatrix SparseLU< MatrixType, SuperLU >::m_sluU [mutable, protected]

Definition at line 376 of file SuperLUSupport.h.

template<typename MatrixType >

SluMatrix SparseLU< MatrixType, SuperLU >::m_sluX [mutable, protected]

Definition at line 377 of file SuperLUSupport.h.

template<typename MatrixType >

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

Definition at line 370 of file SuperLUSupport.h.

---

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

• SuperLUSupport.h