Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Eigen::UmfPackLU< _MatrixType > Class Template Reference

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

#include <UmfPackSupport.h>

Inheritance diagram for Eigen::UmfPackLU< _MatrixType >:
Inheritance graph
[legend]

Public Types

enum  { ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
 
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 MatrixType::StorageIndex StorageIndex
 
typedef Array< double, UMFPACK_CONTROL, 1 > UmfpackControl
 
typedef Array< double, UMFPACK_INFO, 1 > UmfpackInfo
 
typedef Ref< const UmfpackMatrixType, StandardCompressedFormat > UmfpackMatrixRef
 
typedef SparseMatrix< Scalar, ColMajor, int > UmfpackMatrixType
 
typedef Matrix< Scalar, Dynamic, 1 > Vector
 

Public Member Functions

template<typename BDerived , typename XDerived >
bool _solve_impl (const MatrixBase< BDerived > &b, MatrixBase< XDerived > &x) const
 
template<typename InputMatrixType >
void analyzePattern (const InputMatrixType &matrix)
 
Index cols () const
 
template<typename InputMatrixType >
void compute (const InputMatrixType &matrix)
 
Scalar determinant () const
 
void extractData () const
 
template<typename InputMatrixType >
void factorize (const InputMatrixType &matrix)
 
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
 
Index rows () const
 
const UmfpackControl & umfpackControl () const
 
UmfpackControl & umfpackControl ()
 
int umfpackFactorizeReturncode () const
 
 UmfPackLU ()
 
template<typename InputMatrixType >
 UmfPackLU (const InputMatrixType &matrix)
 
void umfpackReportControl ()
 
void umfpackReportInfo ()
 
void umfpackReportStatus ()
 
 ~UmfPackLU ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< UmfPackLU< _MatrixType > >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
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
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Types

typedef SparseSolverBase< UmfPackLU< _MatrixType > > Base
 

Protected Member Functions

void analyzePattern_impl ()
 
void factorize_impl ()
 
template<typename MatrixDerived >
void grab (const EigenBase< MatrixDerived > &A)
 
void grab (const UmfpackMatrixRef &A)
 
void init ()
 

Protected Attributes

int m_analysisIsOk
 
UmfpackControl m_control
 
UmfpackMatrixType m_dummy
 
bool m_extractedDataAreDirty
 
int m_fact_errorCode
 
int m_factorizationIsOk
 
ComputationInfo m_info
 
LUMatrixType m_l
 
void * m_numeric
 
IntColVectorType m_p
 
IntRowVectorType m_q
 
void * m_symbolic
 
LUMatrixType m_u
 
UmfpackInfo m_umfpackInfo
 
UmfpackMatrixRef mp_matrix
 
- 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
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
See also
Sparse solver concept, class SparseLU

Definition at line 152 of file UmfPackSupport.h.

Member Typedef Documentation

template<typename _MatrixType>
typedef SparseSolverBase<UmfPackLU<_MatrixType> > Eigen::UmfPackLU< _MatrixType >::Base
protected

Definition at line 155 of file UmfPackSupport.h.

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

Definition at line 165 of file UmfPackSupport.h.

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

Definition at line 164 of file UmfPackSupport.h.

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

Definition at line 166 of file UmfPackSupport.h.

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

Definition at line 159 of file UmfPackSupport.h.

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

Definition at line 161 of file UmfPackSupport.h.

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

Definition at line 160 of file UmfPackSupport.h.

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

Definition at line 162 of file UmfPackSupport.h.

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

Definition at line 176 of file UmfPackSupport.h.

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

Definition at line 177 of file UmfPackSupport.h.

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

Definition at line 168 of file UmfPackSupport.h.

template<typename _MatrixType>
typedef SparseMatrix<Scalar,ColMajor,int> Eigen::UmfPackLU< _MatrixType >::UmfpackMatrixType

Definition at line 167 of file UmfPackSupport.h.

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

Definition at line 163 of file UmfPackSupport.h.

Member Enumeration Documentation

template<typename _MatrixType>
anonymous enum
Enumerator
ColsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 169 of file UmfPackSupport.h.

Constructor & Destructor Documentation

template<typename _MatrixType>
Eigen::UmfPackLU< _MatrixType >::UmfPackLU ( )
inline

Definition at line 179 of file UmfPackSupport.h.

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

Definition at line 186 of file UmfPackSupport.h.

template<typename _MatrixType>
Eigen::UmfPackLU< _MatrixType >::~UmfPackLU ( )
inline

Definition at line 193 of file UmfPackSupport.h.

template<typename _MatrixType>
Eigen::UmfPackLU< _MatrixType >::UmfPackLU ( const UmfPackLU< _MatrixType > &  )
inlineprivate

Definition at line 431 of file UmfPackSupport.h.

Member Function Documentation

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

Definition at line 473 of file UmfPackSupport.h.

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

Definition at line 258 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::analyzePattern_impl ( )
inlineprotected

Definition at line 368 of file UmfPackSupport.h.

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

Definition at line 200 of file UmfPackSupport.h.

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

Definition at line 242 of file UmfPackSupport.h.

template<typename MatrixType >
UmfPackLU< MatrixType >::Scalar Eigen::UmfPackLU< MatrixType >::determinant ( ) const

Definition at line 464 of file UmfPackSupport.h.

template<typename MatrixType >
void Eigen::UmfPackLU< MatrixType >::extractData ( ) const

Definition at line 436 of file UmfPackSupport.h.

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

Definition at line 308 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::factorize_impl ( )
inlineprotected

Definition at line 382 of file UmfPackSupport.h.

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

Definition at line 394 of file UmfPackSupport.h.

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

Definition at line 400 of file UmfPackSupport.h.

template<typename _MatrixType>
ComputationInfo Eigen::UmfPackLU< _MatrixType >::info ( ) const
inline

Reports whether previous computation was successful.

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

Definition at line 207 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::init ( )
inlineprotected

Definition at line 357 of file UmfPackSupport.h.

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

Definition at line 213 of file UmfPackSupport.h.

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

Definition at line 219 of file UmfPackSupport.h.

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

Definition at line 225 of file UmfPackSupport.h.

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

Definition at line 231 of file UmfPackSupport.h.

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

Definition at line 199 of file UmfPackSupport.h.

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.

Definition at line 285 of file UmfPackSupport.h.

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.

Definition at line 296 of file UmfPackSupport.h.

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

Definition at line 273 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::umfpackReportControl ( )
inline

Prints the current UmfPack control settings.

See also
umfpackControl()

Definition at line 323 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::umfpackReportInfo ( )
inline

Prints statistics collected by UmfPack.

See also
analyzePattern(), compute()

Definition at line 332 of file UmfPackSupport.h.

template<typename _MatrixType>
void Eigen::UmfPackLU< _MatrixType >::umfpackReportStatus ( )
inline

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

See also
analyzePattern(), compute()

Definition at line 342 of file UmfPackSupport.h.

Member Data Documentation

template<typename _MatrixType>
int Eigen::UmfPackLU< _MatrixType >::m_analysisIsOk
protected

Definition at line 427 of file UmfPackSupport.h.

template<typename _MatrixType>
UmfpackControl Eigen::UmfPackLU< _MatrixType >::m_control
protected

Definition at line 412 of file UmfPackSupport.h.

template<typename _MatrixType>
UmfpackMatrixType Eigen::UmfPackLU< _MatrixType >::m_dummy
protected

Definition at line 419 of file UmfPackSupport.h.

template<typename _MatrixType>
bool Eigen::UmfPackLU< _MatrixType >::m_extractedDataAreDirty
mutableprotected

Definition at line 428 of file UmfPackSupport.h.

template<typename _MatrixType>
int Eigen::UmfPackLU< _MatrixType >::m_fact_errorCode
protected

Definition at line 411 of file UmfPackSupport.h.

template<typename _MatrixType>
int Eigen::UmfPackLU< _MatrixType >::m_factorizationIsOk
protected

Definition at line 426 of file UmfPackSupport.h.

template<typename _MatrixType>
ComputationInfo Eigen::UmfPackLU< _MatrixType >::m_info
mutableprotected

Definition at line 425 of file UmfPackSupport.h.

template<typename _MatrixType>
LUMatrixType Eigen::UmfPackLU< _MatrixType >::m_l
mutableprotected

Definition at line 410 of file UmfPackSupport.h.

template<typename _MatrixType>
void* Eigen::UmfPackLU< _MatrixType >::m_numeric
protected

Definition at line 422 of file UmfPackSupport.h.

template<typename _MatrixType>
IntColVectorType Eigen::UmfPackLU< _MatrixType >::m_p
mutableprotected

Definition at line 416 of file UmfPackSupport.h.

template<typename _MatrixType>
IntRowVectorType Eigen::UmfPackLU< _MatrixType >::m_q
mutableprotected

Definition at line 417 of file UmfPackSupport.h.

template<typename _MatrixType>
void* Eigen::UmfPackLU< _MatrixType >::m_symbolic
protected

Definition at line 423 of file UmfPackSupport.h.

template<typename _MatrixType>
LUMatrixType Eigen::UmfPackLU< _MatrixType >::m_u
mutableprotected

Definition at line 415 of file UmfPackSupport.h.

template<typename _MatrixType>
UmfpackInfo Eigen::UmfPackLU< _MatrixType >::m_umfpackInfo
mutableprotected

Definition at line 413 of file UmfPackSupport.h.

template<typename _MatrixType>
UmfpackMatrixRef Eigen::UmfPackLU< _MatrixType >::mp_matrix
protected

Definition at line 420 of file UmfPackSupport.h.

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

gtsam
Author(s):
autogenerated on Sat May 8 2021 02:55:42