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

#include <KLUSupport.h>

Inheritance diagram for Eigen::KLU< _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 Ref< const KLUMatrixType, StandardCompressedFormat > KLUMatrixRef
 
typedef SparseMatrix< Scalar, ColMajor, int > KLUMatrixType
 
typedef SparseMatrix< Scalar > LUMatrixType
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 
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)
 
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
template<typename InputMatrixType >
void compute (const InputMatrixType &matrix)
 
template<typename InputMatrixType >
void factorize (const InputMatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
 KLU ()
 
template<typename InputMatrixType >
 KLU (const InputMatrixType &matrix)
 
klu_common & kluCommon ()
 
const klu_common & kluCommon () const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
 ~KLU ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< KLU< _MatrixType > >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
KLU< _MatrixType > & derived ()
 
const KLU< _MatrixType > & derived () const
 
const Solve< KLU< _MatrixType >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< KLU< _MatrixType >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Types

typedef SparseSolverBase< KLU< _MatrixType > > Base
 

Protected Member Functions

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

Protected Attributes

int m_analysisIsOk
 
klu_common m_common
 
KLUMatrixType m_dummy
 
bool m_extractedDataAreDirty
 
int m_factorizationIsOk
 
ComputationInfo m_info
 
klu_numeric * m_numeric
 
klu_symbolic * m_symbolic
 
KLUMatrixRef mp_matrix
 
- Protected Attributes inherited from Eigen::SparseSolverBase< KLU< _MatrixType > >
bool m_isInitialized
 

Private Member Functions

 KLU (const KLU &)
 

Detailed Description

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

Definition at line 60 of file KLUSupport.h.

Member Typedef Documentation

◆ Base

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

Definition at line 63 of file KLUSupport.h.

◆ IntColVectorType

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

Definition at line 73 of file KLUSupport.h.

◆ IntRowVectorType

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

Definition at line 72 of file KLUSupport.h.

◆ KLUMatrixRef

template<typename _MatrixType >
typedef Ref<const KLUMatrixType, StandardCompressedFormat> Eigen::KLU< _MatrixType >::KLUMatrixRef

Definition at line 76 of file KLUSupport.h.

◆ KLUMatrixType

template<typename _MatrixType >
typedef SparseMatrix<Scalar,ColMajor,int> Eigen::KLU< _MatrixType >::KLUMatrixType

Definition at line 75 of file KLUSupport.h.

◆ LUMatrixType

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

Definition at line 74 of file KLUSupport.h.

◆ MatrixType

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

Definition at line 67 of file KLUSupport.h.

◆ RealScalar

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

Definition at line 69 of file KLUSupport.h.

◆ Scalar

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

Definition at line 68 of file KLUSupport.h.

◆ StorageIndex

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

Definition at line 70 of file KLUSupport.h.

◆ Vector

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

Definition at line 71 of file KLUSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType >
anonymous enum
Enumerator
ColsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 77 of file KLUSupport.h.

Constructor & Destructor Documentation

◆ KLU() [1/3]

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

Definition at line 84 of file KLUSupport.h.

◆ KLU() [2/3]

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

Definition at line 91 of file KLUSupport.h.

◆ ~KLU()

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

Definition at line 98 of file KLUSupport.h.

◆ KLU() [3/3]

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

Definition at line 299 of file KLUSupport.h.

Member Function Documentation

◆ _solve_impl()

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

Definition at line 343 of file KLUSupport.h.

◆ analyzePattern()

template<typename _MatrixType >
template<typename InputMatrixType >
void Eigen::KLU< _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 163 of file KLUSupport.h.

◆ analyzePattern_impl()

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

Definition at line 235 of file KLUSupport.h.

◆ cols()

template<typename _MatrixType >
EIGEN_CONSTEXPR Index Eigen::KLU< _MatrixType >::cols ( ) const
inline

Definition at line 105 of file KLUSupport.h.

◆ compute()

template<typename _MatrixType >
template<typename InputMatrixType >
void Eigen::KLU< _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 147 of file KLUSupport.h.

◆ factorize()

template<typename _MatrixType >
template<typename InputMatrixType >
void Eigen::KLU< _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 201 of file KLUSupport.h.

◆ factorize_impl()

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

Definition at line 251 of file KLUSupport.h.

◆ grab() [1/2]

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

Definition at line 264 of file KLUSupport.h.

◆ grab() [2/2]

template<typename _MatrixType >
void Eigen::KLU< _MatrixType >::grab ( const KLUMatrixRef &  A)
inlineprotected

Definition at line 270 of file KLUSupport.h.

◆ info()

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

Reports whether previous computation was successful.

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

Definition at line 112 of file KLUSupport.h.

◆ init()

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

Definition at line 224 of file KLUSupport.h.

◆ kluCommon() [1/2]

template<typename _MatrixType >
klu_common& Eigen::KLU< _MatrixType >::kluCommon ( )
inline

Provides access to the control settings array used by UmfPack.

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

See KLU documentation for details.

Definition at line 189 of file KLUSupport.h.

◆ kluCommon() [2/2]

template<typename _MatrixType >
const klu_common& Eigen::KLU< _MatrixType >::kluCommon ( ) const
inline

Provides access to the control settings array used by KLU.

See KLU documentation for details.

Definition at line 178 of file KLUSupport.h.

◆ rows()

template<typename _MatrixType >
EIGEN_CONSTEXPR Index Eigen::KLU< _MatrixType >::rows ( ) const
inline

Definition at line 104 of file KLUSupport.h.

Member Data Documentation

◆ m_analysisIsOk

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

Definition at line 295 of file KLUSupport.h.

◆ m_common

template<typename _MatrixType >
klu_common Eigen::KLU< _MatrixType >::m_common
protected

Definition at line 292 of file KLUSupport.h.

◆ m_dummy

template<typename _MatrixType >
KLUMatrixType Eigen::KLU< _MatrixType >::m_dummy
protected

Definition at line 287 of file KLUSupport.h.

◆ m_extractedDataAreDirty

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

Definition at line 296 of file KLUSupport.h.

◆ m_factorizationIsOk

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

Definition at line 294 of file KLUSupport.h.

◆ m_info

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

Definition at line 293 of file KLUSupport.h.

◆ m_numeric

template<typename _MatrixType >
klu_numeric* Eigen::KLU< _MatrixType >::m_numeric
protected

Definition at line 290 of file KLUSupport.h.

◆ m_symbolic

template<typename _MatrixType >
klu_symbolic* Eigen::KLU< _MatrixType >::m_symbolic
protected

Definition at line 291 of file KLUSupport.h.

◆ mp_matrix

template<typename _MatrixType >
KLUMatrixRef Eigen::KLU< _MatrixType >::mp_matrix
protected

Definition at line 288 of file KLUSupport.h.

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

gtsam
Author(s):
autogenerated on Wed May 15 2024 15:28:13