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

#include <UmfPackSupport.h>

Inheritance diagram for Eigen::UmfPackLU< _MatrixType >:

Public Types
enum	{ ColsAtCompileTime = MatrixType::ColsAtCompileTime , MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }

typedef _MatrixType	MatrixType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::StorageIndex	StorageIndex

typedef Matrix< Scalar, Dynamic, 1 >	Vector

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

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

typedef SparseMatrix< Scalar >	LUMatrixType

typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	UmfpackMatrixType

typedef Ref< const UmfpackMatrixType, StandardCompressedFormat >	UmfpackMatrixRef

typedef Array< double, UMFPACK_CONTROL, 1 >	UmfpackControl

typedef Array< double, UMFPACK_INFO, 1 >	UmfpackInfo

Public Member Functions
	UmfPackLU ()

template<typename InputMatrixType >
	UmfPackLU (const InputMatrixType &matrix)

	~UmfPackLU ()

Index	rows () const

Index	cols () const

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

const LUMatrixType &	matrixL () const

const LUMatrixType &	matrixU () const

const IntColVectorType &	permutationP () const

const IntRowVectorType &	permutationQ () const

template<typename InputMatrixType >
void	compute (const InputMatrixType &matrix)

template<typename InputMatrixType >
void	analyzePattern (const InputMatrixType &matrix)

int	umfpackFactorizeReturncode () const

const UmfpackControl &	umfpackControl () const

UmfpackControl &	umfpackControl ()

template<typename InputMatrixType >
void	factorize (const InputMatrixType &matrix)

void	printUmfpackControl ()

void	printUmfpackInfo ()

void	printUmfpackStatus ()

template<typename BDerived , typename XDerived >
bool	_solve_impl (const MatrixBase< BDerived > &b, MatrixBase< XDerived > &x) const

Scalar	determinant () const

void	extractData () const

Public Member Functions inherited from Eigen::SparseSolverBase< UmfPackLU< _MatrixType > >
	SparseSolverBase ()

	~SparseSolverBase ()

UmfPackLU< _MatrixType > &	derived ()

const UmfPackLU< _MatrixType > &	derived () const

const Solve< UmfPackLU< _MatrixType >, Rhs >	solve (const MatrixBase< Rhs > &b) const

const Solve< UmfPackLU< _MatrixType >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Types
typedef SparseSolverBase< UmfPackLU< _MatrixType > >	Base

Protected Member Functions
void	init ()

void	analyzePattern_impl ()

void	factorize_impl ()

template<typename MatrixDerived >
void	grab (const EigenBase< MatrixDerived > &A)

void	grab (const UmfpackMatrixRef &A)

Protected Attributes
LUMatrixType	m_l

StorageIndex	m_fact_errorCode

UmfpackControl	m_control

UmfpackInfo	m_umfpackInfo

LUMatrixType	m_u

IntColVectorType	m_p

IntRowVectorType	m_q

UmfpackMatrixType	m_dummy

UmfpackMatrixRef	mp_matrix

void *	m_numeric

void *	m_symbolic

ComputationInfo	m_info

int	m_factorizationIsOk

int	m_analysisIsOk

bool	m_extractedDataAreDirty

Protected Attributes inherited from Eigen::SparseSolverBase< UmfPackLU< _MatrixType > >
bool	m_isInitialized

Private Member Functions
	UmfPackLU (const UmfPackLU &)

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 squared and full rank. The vectors or matrices X and B can be either dense or sparse.

Warning: The input matrix A should be in a compressed and column-major form. Otherwise an expensive copy will be made. You can call the inexpensive makeCompressed() to get a compressed matrix.

Template Parameters

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

\implsparsesolverconcept

See also: TutorialSparseSolverConcept, class SparseLU

Member Typedef Documentation

◆ Base

template<typename _MatrixType >

typedef SparseSolverBase<UmfPackLU<_MatrixType> > Eigen::UmfPackLU< _MatrixType >::Base

protected

◆ IntColVectorType

template<typename _MatrixType >

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> Eigen::UmfPackLU< _MatrixType >::IntColVectorType

◆ IntRowVectorType

template<typename _MatrixType >

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> Eigen::UmfPackLU< _MatrixType >::IntRowVectorType

◆ LUMatrixType

template<typename _MatrixType >

typedef SparseMatrix<Scalar> Eigen::UmfPackLU< _MatrixType >::LUMatrixType

◆ MatrixType

template<typename _MatrixType >

typedef _MatrixType Eigen::UmfPackLU< _MatrixType >::MatrixType

◆ RealScalar

template<typename _MatrixType >

typedef MatrixType::RealScalar Eigen::UmfPackLU< _MatrixType >::RealScalar

◆ Scalar

template<typename _MatrixType >

typedef MatrixType::Scalar Eigen::UmfPackLU< _MatrixType >::Scalar

◆ StorageIndex

template<typename _MatrixType >

typedef MatrixType::StorageIndex Eigen::UmfPackLU< _MatrixType >::StorageIndex

◆ UmfpackControl

template<typename _MatrixType >

typedef Array<double, UMFPACK_CONTROL, 1> Eigen::UmfPackLU< _MatrixType >::UmfpackControl

◆ UmfpackInfo

template<typename _MatrixType >

typedef Array<double, UMFPACK_INFO, 1> Eigen::UmfPackLU< _MatrixType >::UmfpackInfo

◆ UmfpackMatrixRef

template<typename _MatrixType >

typedef Ref<const UmfpackMatrixType, StandardCompressedFormat> Eigen::UmfPackLU< _MatrixType >::UmfpackMatrixRef

◆ UmfpackMatrixType

template<typename _MatrixType >

typedef SparseMatrix<Scalar,ColMajor,StorageIndex> Eigen::UmfPackLU< _MatrixType >::UmfpackMatrixType

◆ Vector

template<typename _MatrixType >

typedef Matrix<Scalar,Dynamic,1> Eigen::UmfPackLU< _MatrixType >::Vector

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType >

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime

Constructor & Destructor Documentation

◆ UmfPackLU() [1/3]

template<typename _MatrixType >

Eigen::UmfPackLU< _MatrixType >::UmfPackLU ( )

inline

◆ UmfPackLU() [2/3]

template<typename _MatrixType >

template<typename InputMatrixType >

Eigen::UmfPackLU< _MatrixType >::UmfPackLU ( const InputMatrixType & matrix )

inlineexplicit

◆ ~UmfPackLU()

template<typename _MatrixType >

Eigen::UmfPackLU< _MatrixType >::~UmfPackLU ( )

inline

◆ UmfPackLU() [3/3]

template<typename _MatrixType >

Eigen::UmfPackLU< _MatrixType >::UmfPackLU ( const UmfPackLU< _MatrixType > & )

inlineprivate

Member Function Documentation

◆ _solve_impl()

template<typename MatrixType >

template<typename BDerived , typename XDerived >

bool Eigen::UmfPackLU< MatrixType >::_solve_impl	(	const MatrixBase< BDerived > &	b,
		MatrixBase< XDerived > &	x
	)		const

◆ analyzePattern()

template<typename _MatrixType >

template<typename InputMatrixType >

void Eigen::UmfPackLU< _MatrixType >::analyzePattern ( const InputMatrixType & matrix )

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

◆ analyzePattern_impl()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::analyzePattern_impl ( )

inlineprotected

◆ cols()

template<typename _MatrixType >

Index Eigen::UmfPackLU< _MatrixType >::cols ( void ) const

inline

◆ compute()

template<typename _MatrixType >

template<typename InputMatrixType >

void Eigen::UmfPackLU< _MatrixType >::compute ( const InputMatrixType & matrix )

inline

Computes the sparse Cholesky decomposition of matrix Note that the matrix should be column-major, and in compressed format for best performance.

See also: SparseMatrix::makeCompressed().

◆ determinant()

template<typename MatrixType >

UmfPackLU< MatrixType >::Scalar Eigen::UmfPackLU< MatrixType >::determinant

◆ extractData()

template<typename MatrixType >

void Eigen::UmfPackLU< MatrixType >::extractData

◆ factorize()

template<typename _MatrixType >

template<typename InputMatrixType >

void Eigen::UmfPackLU< _MatrixType >::factorize ( const InputMatrixType & matrix )

inline

Performs a numeric decomposition of matrix

The given matrix must has the same sparcity than the matrix on which the pattern anylysis has been performed.

See also: analyzePattern(), compute()

◆ factorize_impl()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::factorize_impl ( )

inlineprotected

◆ grab() [1/2]

template<typename _MatrixType >

template<typename MatrixDerived >

void Eigen::UmfPackLU< _MatrixType >::grab ( const EigenBase< MatrixDerived > & A )

inlineprotected

◆ grab() [2/2]

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::grab ( const UmfpackMatrixRef & A )

inlineprotected

◆ info()

template<typename _MatrixType >

ComputationInfo Eigen::UmfPackLU< _MatrixType >::info ( ) const

inline

Reports whether previous computation was successful.

Returns: Success if computation was successful, NumericalIssue if the matrix.appears to be negative.

◆ init()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::init ( )

inlineprotected

◆ matrixL()

template<typename _MatrixType >

const LUMatrixType& Eigen::UmfPackLU< _MatrixType >::matrixL ( ) const

inline

◆ matrixU()

template<typename _MatrixType >

const LUMatrixType& Eigen::UmfPackLU< _MatrixType >::matrixU ( ) const

inline

◆ permutationP()

template<typename _MatrixType >

const IntColVectorType& Eigen::UmfPackLU< _MatrixType >::permutationP ( ) const

inline

◆ permutationQ()

template<typename _MatrixType >

const IntRowVectorType& Eigen::UmfPackLU< _MatrixType >::permutationQ ( ) const

inline

◆ printUmfpackControl()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::printUmfpackControl ( )

inline

Prints the current UmfPack control settings.

See also: umfpackControl()

◆ printUmfpackInfo()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::printUmfpackInfo ( )

inline

Prints statistics collected by UmfPack.

See also: analyzePattern(), compute()

◆ printUmfpackStatus()

template<typename _MatrixType >

void Eigen::UmfPackLU< _MatrixType >::printUmfpackStatus ( )

inline

Prints the status of the previous factorization operation performed by UmfPack (symbolic or numerical factorization).

See also: analyzePattern(), compute()

◆ rows()

template<typename _MatrixType >

Index Eigen::UmfPackLU< _MatrixType >::rows ( void ) const

inline

◆ umfpackControl() [1/2]

template<typename _MatrixType >

UmfpackControl& Eigen::UmfPackLU< _MatrixType >::umfpackControl ( )

inline

Provides access to the control settings array used by UmfPack.

If this array contains NaN's, the default values are used.

See UMFPACK documentation for details.

◆ umfpackControl() [2/2]

template<typename _MatrixType >

const UmfpackControl& Eigen::UmfPackLU< _MatrixType >::umfpackControl ( ) const

inline

Provides access to the control settings array used by UmfPack.

If this array contains NaN's, the default values are used.

See UMFPACK documentation for details.

◆ umfpackFactorizeReturncode()

template<typename _MatrixType >

int Eigen::UmfPackLU< _MatrixType >::umfpackFactorizeReturncode ( ) const

inline

Provides the return status code returned by UmfPack during the numeric factorization.

See also: factorize(), compute()

Member Data Documentation

◆ m_analysisIsOk

template<typename _MatrixType >

int Eigen::UmfPackLU< _MatrixType >::m_analysisIsOk

protected

◆ m_control

template<typename _MatrixType >

UmfpackControl Eigen::UmfPackLU< _MatrixType >::m_control

protected

◆ m_dummy

template<typename _MatrixType >

UmfpackMatrixType Eigen::UmfPackLU< _MatrixType >::m_dummy

protected

◆ m_extractedDataAreDirty

template<typename _MatrixType >

bool Eigen::UmfPackLU< _MatrixType >::m_extractedDataAreDirty

mutableprotected

◆ m_fact_errorCode

template<typename _MatrixType >

StorageIndex Eigen::UmfPackLU< _MatrixType >::m_fact_errorCode

protected

◆ m_factorizationIsOk

template<typename _MatrixType >

int Eigen::UmfPackLU< _MatrixType >::m_factorizationIsOk

protected

◆ m_info

template<typename _MatrixType >

ComputationInfo Eigen::UmfPackLU< _MatrixType >::m_info

mutableprotected

◆ m_l

template<typename _MatrixType >

LUMatrixType Eigen::UmfPackLU< _MatrixType >::m_l

mutableprotected

◆ m_numeric

template<typename _MatrixType >

void* Eigen::UmfPackLU< _MatrixType >::m_numeric

protected

◆ m_p

template<typename _MatrixType >

IntColVectorType Eigen::UmfPackLU< _MatrixType >::m_p

mutableprotected

◆ m_q

template<typename _MatrixType >

IntRowVectorType Eigen::UmfPackLU< _MatrixType >::m_q

mutableprotected

◆ m_symbolic

template<typename _MatrixType >

void* Eigen::UmfPackLU< _MatrixType >::m_symbolic

protected

◆ m_u

template<typename _MatrixType >

LUMatrixType Eigen::UmfPackLU< _MatrixType >::m_u

mutableprotected

◆ m_umfpackInfo

template<typename _MatrixType >

UmfpackInfo Eigen::UmfPackLU< _MatrixType >::m_umfpackInfo

mutableprotected

◆ mp_matrix

template<typename _MatrixType >

UmfpackMatrixRef Eigen::UmfPackLU< _MatrixType >::mp_matrix

protected

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

/home/runner/work/NDDEM/NDDEM/src/CoarseGraining/Eigen/src/UmfPackSupport/UmfPackSupport.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ IntColVectorType

◆ IntRowVectorType

◆ LUMatrixType

◆ MatrixType

◆ RealScalar

◆ Scalar

◆ StorageIndex

◆ UmfpackControl

◆ UmfpackInfo

◆ UmfpackMatrixRef

◆ UmfpackMatrixType

◆ Vector

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ UmfPackLU() [1/3]

◆ UmfPackLU() [2/3]

◆ ~UmfPackLU()

◆ UmfPackLU() [3/3]

Member Function Documentation

◆ _solve_impl()

◆ analyzePattern()

◆ analyzePattern_impl()

◆ cols()

◆ compute()

◆ determinant()

◆ extractData()

◆ factorize()

◆ factorize_impl()

◆ grab() [1/2]

◆ grab() [2/2]

◆ info()

◆ init()

◆ matrixL()

◆ matrixU()

◆ permutationP()

◆ permutationQ()

◆ printUmfpackControl()

◆ printUmfpackInfo()

◆ printUmfpackStatus()

◆ rows()

◆ umfpackControl() [1/2]

◆ umfpackControl() [2/2]

◆ umfpackFactorizeReturncode()

Member Data Documentation

◆ m_analysisIsOk

◆ m_control

◆ m_dummy

◆ m_extractedDataAreDirty

◆ m_fact_errorCode

◆ m_factorizationIsOk

◆ m_info

◆ m_l

◆ m_numeric

◆ m_p

◆ m_q

◆ m_symbolic

◆ m_u

◆ m_umfpackInfo

◆ mp_matrix

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