UmfPackLU< _MatrixType > Class Template Reference

A sparse LU factorization and solver based on UmfPack. More...

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< Scalar >	LUMatrixType
typedef _MatrixType	MatrixType
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::Scalar	Scalar
typedef Matrix< Scalar, Dynamic, 1 >	Vector
Public Member Functions
void	analyzePattern (const MatrixType &matrix)
Index	cols () const
void	compute (const MatrixType &matrix)
Scalar	determinant () const
void	extractData () const
void	factorize (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
const LUMatrixType &	matrixL () const
const LUMatrixType &	matrixU () const
const IntColVectorType &	permutationP () const
const IntRowVectorType &	permutationQ () const
Index	rows () const
template<typename Rhs >
const internal::solve_retval < UmfPackLU, Rhs >	solve (const MatrixBase< Rhs > &b) const
	UmfPackLU ()
	UmfPackLU (const MatrixType &matrix)
	~UmfPackLU ()
Protected Member Functions
void	init ()
Protected Attributes
int	m_analysisIsOk
bool	m_extractedDataAreDirty
int	m_factorizationIsOk
ComputationInfo	m_info
bool	m_isInitialized
LUMatrixType	m_l
const MatrixType *	m_matrixRef
void *	m_numeric
IntColVectorType	m_p
IntRowVectorType	m_q
void *	m_symbolic
LUMatrixType	m_u

---

Detailed Description

template<typename _MatrixType>
class Eigen::UmfPackLU< _MatrixType >

A sparse LU factorization and solver based on UmfPack.

This class allows to solve for A.X = B sparse linear problems via a LU factorization using the UmfPack library. The sparse matrix A must be column-major, squared and full rank. The vectors or matrices X and B can be either dense or sparse.

Template Parameters:

_MatrixType

the type of the sparse matrix A, it must be a SparseMatrix<>

See also:

Solving linear problems

---

Member Typedef Documentation

typedef MatrixType::Index Index

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> IntColVectorType

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> IntRowVectorType

typedef SparseMatrix<Scalar> LUMatrixType

typedef _MatrixType MatrixType

typedef MatrixType::RealScalar RealScalar

typedef MatrixType::Scalar Scalar

typedef Matrix<Scalar,Dynamic,1> Vector

---

Constructor & Destructor Documentation

UmfPackLU

(

)

[inline]

UmfPackLU

(

const MatrixType &

matrix

)

[inline]

~UmfPackLU

(

)

[inline]

---

Member Function Documentation

void analyzePattern

(

const MatrixType &

matrix

)

[inline]

Returns:

the solution x of using the current decomposition of A.

See also:

compute() 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()

Index cols

(

void

)

const [inline]

void compute

(

const MatrixType &

matrix

)

[inline]

Computes the sparse Cholesky decomposition of matrix

UmfPackLU< MatrixType >::Scalar determinant

(

)

const

void extractData

(

)

const

void factorize

(

const MatrixType &

matrix

)

[inline]

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()

ComputationInfo info

(

)

const [inline]

Reports whether previous computation was successful.

Returns:

Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.

void init

(

)

[inline, protected]

const LUMatrixType& matrixL

(

)

const [inline]

const LUMatrixType& matrixU

(

)

const [inline]

const IntColVectorType& permutationP

(

)

const [inline]

const IntRowVectorType& permutationQ

(

)

const [inline]

Index rows

(

void

)

const [inline]

const internal::solve_retval<UmfPackLU, Rhs> solve

(

const MatrixBase< Rhs > &

b

)

const [inline]

Returns:

the solution x of using the current decomposition of A.

See also:

compute()

---

Member Data Documentation

int m_analysisIsOk [protected]

bool m_extractedDataAreDirty [mutable, protected]

int m_factorizationIsOk [protected]

ComputationInfo m_info [mutable, protected]

bool m_isInitialized [protected]

LUMatrixType m_l [mutable, protected]

const MatrixType* m_matrixRef [protected]

void* m_numeric [protected]

IntColVectorType m_p [mutable, protected]

IntRowVectorType m_q [mutable, protected]

void* m_symbolic [protected]

LUMatrixType m_u [mutable, protected]

---

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