Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering > Class Template Reference

#include <SimplicialCholesky.h>

Inheritance diagram for Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >:
Inheritance graph
[legend]

Public Types

enum  { UpLo = _UpLo }
 
typedef SimplicialCholeskyBase< SimplicialCholeskyBase
 
typedef SparseMatrix< Scalar, ColMajor, StorageIndexCholMatrixType
 
typedef internal::traits< SimplicialLDLT< MatrixType, UpLo > > LDLTTraits
 
typedef internal::traits< SimplicialLLT< MatrixType, UpLo > > LLTTraits
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 
typedef internal::traits< SimplicialCholeskyTraits
 
typedef Matrix< Scalar, Dynamic, 1 > VectorType
 
- Public Types inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
enum  
 
enum  
 
typedef SparseMatrix< Scalar, ColMajor, StorageIndexCholMatrixType
 
typedef CholMatrixType const * ConstCholMatrixPtr
 
typedef internal::traits< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >::MatrixType MatrixType
 
typedef internal::traits< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >::OrderingType OrderingType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 
typedef Matrix< StorageIndex, Dynamic, 1 > VectorI
 
typedef Matrix< Scalar, Dynamic, 1 > VectorType
 

Public Member Functions

template<typename Rhs , typename Dest >
void _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
 
template<typename Rhs , typename Dest >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
void analyzePattern (const MatrixType &a)
 
SimplicialCholeskycompute (const MatrixType &matrix)
 
Scalar determinant () const
 
void factorize (const MatrixType &a)
 
const CholMatrixType rawMatrix () const
 
SimplicialCholeskysetMode (SimplicialCholeskyMode mode)
 
 SimplicialCholesky ()
 
 SimplicialCholesky (const MatrixType &matrix)
 
const VectorType vectorD () const
 
- Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
void _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
 
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
Index cols () const
 
SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & derived ()
 
const SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & derived () const
 
void dumpMemory (Stream &s)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > & permutationP () const
 
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > & permutationPinv () const
 
Index rows () const
 
SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & setShift (const RealScalar &offset, const RealScalar &scale=1)
 
 SimplicialCholeskyBase ()
 
 SimplicialCholeskyBase (const MatrixType &matrix)
 
 ~SimplicialCholeskyBase ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & derived ()
 
const SimplicialCholesky< _MatrixType, _UpLo, _Ordering > & derived () const
 
const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Attributes

bool m_LDLT
 
- Protected Attributes inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
bool m_analysisIsOk
 
VectorType m_diag
 
bool m_factorizationIsOk
 
ComputationInfo m_info
 
CholMatrixType m_matrix
 
VectorI m_nonZerosPerCol
 
PermutationMatrix< Dynamic, Dynamic, StorageIndexm_P
 
VectorI m_parent
 
PermutationMatrix< Dynamic, Dynamic, StorageIndexm_Pinv
 
RealScalar m_shiftOffset
 
RealScalar m_shiftScale
 
- Protected Attributes inherited from Eigen::SparseSolverBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
bool m_isInitialized
 

Additional Inherited Members

- Protected Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
void analyzePattern (const MatrixType &a, bool doLDLT)
 
void analyzePattern_preordered (const CholMatrixType &a, bool doLDLT)
 
void compute (const MatrixType &matrix)
 
void factorize (const MatrixType &a)
 
void factorize_preordered (const CholMatrixType &a)
 
void ordering (const MatrixType &a, ConstCholMatrixPtr &pmat, CholMatrixType &ap)
 

Detailed Description

template<typename _MatrixType, int _UpLo, typename _Ordering>
class Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >

Deprecated:
use SimplicialLDLT or class SimplicialLLT
See also
class SimplicialLDLT, class SimplicialLLT

Definition at line 276 of file SimplicialCholesky.h.

Member Typedef Documentation

◆ Base

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef SimplicialCholeskyBase<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Base

Definition at line 516 of file SimplicialCholesky.h.

◆ CholMatrixType

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef SparseMatrix<Scalar,ColMajor,StorageIndex> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::CholMatrixType

Definition at line 520 of file SimplicialCholesky.h.

◆ LDLTTraits

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef internal::traits<SimplicialLDLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::LDLTTraits

Definition at line 523 of file SimplicialCholesky.h.

◆ LLTTraits

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef internal::traits<SimplicialLLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::LLTTraits

Definition at line 524 of file SimplicialCholesky.h.

◆ MatrixType

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef _MatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::MatrixType

Definition at line 514 of file SimplicialCholesky.h.

◆ RealScalar

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef MatrixType::RealScalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::RealScalar

Definition at line 518 of file SimplicialCholesky.h.

◆ Scalar

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef MatrixType::Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Scalar

Definition at line 517 of file SimplicialCholesky.h.

◆ StorageIndex

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef MatrixType::StorageIndex Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::StorageIndex

Definition at line 519 of file SimplicialCholesky.h.

◆ Traits

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef internal::traits<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Traits

Definition at line 522 of file SimplicialCholesky.h.

◆ VectorType

template<typename _MatrixType, int _UpLo, typename _Ordering>
typedef Matrix<Scalar,Dynamic,1> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::VectorType

Definition at line 521 of file SimplicialCholesky.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType, int _UpLo, typename _Ordering>
anonymous enum
Enumerator
UpLo 

Definition at line 515 of file SimplicialCholesky.h.

Constructor & Destructor Documentation

◆ SimplicialCholesky() [1/2]

template<typename _MatrixType, int _UpLo, typename _Ordering>
Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::SimplicialCholesky ( )
inline

Definition at line 526 of file SimplicialCholesky.h.

◆ SimplicialCholesky() [2/2]

template<typename _MatrixType, int _UpLo, typename _Ordering>
Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::SimplicialCholesky ( const MatrixType matrix)
inlineexplicit

Definition at line 528 of file SimplicialCholesky.h.

Member Function Documentation

◆ _solve_impl() [1/2]

template<typename _MatrixType, int _UpLo, typename _Ordering>
template<typename Rhs , typename Dest >
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::_solve_impl ( const MatrixBase< Rhs > &  b,
MatrixBase< Dest > &  dest 
) const
inline

Definition at line 597 of file SimplicialCholesky.h.

◆ _solve_impl() [2/2]

template<typename _MatrixType, int _UpLo, typename _Ordering>
template<typename Rhs , typename Dest >
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::_solve_impl ( const SparseMatrixBase< Rhs > &  b,
SparseMatrixBase< Dest > &  dest 
) const
inline

Definition at line 635 of file SimplicialCholesky.h.

◆ analyzePattern()

template<typename _MatrixType, int _UpLo, typename _Ordering>
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::analyzePattern ( const MatrixType a)
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()

Definition at line 576 of file SimplicialCholesky.h.

◆ compute()

template<typename _MatrixType, int _UpLo, typename _Ordering>
SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::compute ( const MatrixType matrix)
inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 561 of file SimplicialCholesky.h.

◆ determinant()

template<typename _MatrixType, int _UpLo, typename _Ordering>
Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::determinant ( ) const
inline

Definition at line 640 of file SimplicialCholesky.h.

◆ factorize()

template<typename _MatrixType, int _UpLo, typename _Ordering>
void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::factorize ( const MatrixType a)
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()

Definition at line 587 of file SimplicialCholesky.h.

◆ rawMatrix()

template<typename _MatrixType, int _UpLo, typename _Ordering>
const CholMatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::rawMatrix ( ) const
inline

Definition at line 555 of file SimplicialCholesky.h.

◆ setMode()

template<typename _MatrixType, int _UpLo, typename _Ordering>
SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::setMode ( SimplicialCholeskyMode  mode)
inline

Definition at line 534 of file SimplicialCholesky.h.

◆ vectorD()

template<typename _MatrixType, int _UpLo, typename _Ordering>
const VectorType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::vectorD ( ) const
inline

Definition at line 551 of file SimplicialCholesky.h.

Member Data Documentation

◆ m_LDLT

template<typename _MatrixType, int _UpLo, typename _Ordering>
bool Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::m_LDLT
protected

Definition at line 654 of file SimplicialCholesky.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:08