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

The base class for the direct Cholesky factorization of Cholmod. More...

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodBase< _MatrixType, _UpLo, Derived >:
Inheritance graph
[legend]

Public Types

enum  { UpLo = _UpLo }
 
enum  { ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
 
typedef MatrixType CholMatrixType
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::StorageIndex StorageIndex
 

Public Member Functions

template<typename Rhs , typename Dest >
void _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
 
template<typename RhsDerived , typename DestDerived >
void _solve_impl (const SparseMatrixBase< RhsDerived > &b, SparseMatrixBase< DestDerived > &dest) const
 
void analyzePattern (const MatrixType &matrix)
 
cholmod_common & cholmod ()
 
 CholmodBase ()
 
 CholmodBase (const MatrixType &matrix)
 
StorageIndex cols () const
 
Derived & compute (const MatrixType &matrix)
 
Scalar determinant () const
 
template<typename Stream >
void dumpMemory (Stream &)
 
void factorize (const MatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
Scalar logDeterminant () const
 
StorageIndex rows () const
 
Derived & setShift (const RealScalar &offset)
 
 ~CholmodBase ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
template<typename Rhs , typename Dest >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
Derived & derived ()
 
const Derived & derived () const
 
template<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
 
template<typename Rhs >
const Solve< Derived, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Types

typedef SparseSolverBase< Derived > Base
 

Protected Attributes

int m_analysisIsOk
 
cholmod_common m_cholmod
 
cholmod_factor * m_cholmodFactor
 
int m_factorizationIsOk
 
ComputationInfo m_info
 
double m_shiftOffset [2]
 
- Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool m_isInitialized
 

Detailed Description

template<typename _MatrixType, int _UpLo, typename Derived>
class Eigen::CholmodBase< _MatrixType, _UpLo, Derived >

The base class for the direct Cholesky factorization of Cholmod.

See also
class CholmodSupernodalLLT, class CholmodSimplicialLDLT, class CholmodSimplicialLLT

Definition at line 214 of file CholmodSupport.h.

Member Typedef Documentation

◆ Base

template<typename _MatrixType, int _UpLo, typename Derived>
typedef SparseSolverBase<Derived> Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::Base
protected

Definition at line 217 of file CholmodSupport.h.

◆ CholMatrixType

template<typename _MatrixType, int _UpLo, typename Derived>
typedef MatrixType Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::CholMatrixType

Definition at line 225 of file CholmodSupport.h.

◆ MatrixType

template<typename _MatrixType, int _UpLo, typename Derived>
typedef _MatrixType Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::MatrixType

Definition at line 221 of file CholmodSupport.h.

◆ RealScalar

template<typename _MatrixType, int _UpLo, typename Derived>
typedef MatrixType::RealScalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::RealScalar

Definition at line 224 of file CholmodSupport.h.

◆ Scalar

template<typename _MatrixType, int _UpLo, typename Derived>
typedef MatrixType::Scalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::Scalar

Definition at line 223 of file CholmodSupport.h.

◆ StorageIndex

template<typename _MatrixType, int _UpLo, typename Derived>
typedef MatrixType::StorageIndex Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::StorageIndex

Definition at line 226 of file CholmodSupport.h.

Member Enumeration Documentation

◆ anonymous enum

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

Definition at line 222 of file CholmodSupport.h.

◆ anonymous enum

template<typename _MatrixType, int _UpLo, typename Derived>
anonymous enum
Enumerator
ColsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 227 of file CholmodSupport.h.

Constructor & Destructor Documentation

◆ CholmodBase() [1/2]

template<typename _MatrixType, int _UpLo, typename Derived>
Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::CholmodBase ( )
inline

Definition at line 234 of file CholmodSupport.h.

◆ CholmodBase() [2/2]

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

Definition at line 242 of file CholmodSupport.h.

◆ ~CholmodBase()

template<typename _MatrixType, int _UpLo, typename Derived>
Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::~CholmodBase ( )
inline

Definition at line 251 of file CholmodSupport.h.

Member Function Documentation

◆ _solve_impl() [1/2]

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

Definition at line 326 of file CholmodSupport.h.

◆ _solve_impl() [2/2]

template<typename _MatrixType, int _UpLo, typename Derived>
template<typename RhsDerived , typename DestDerived >
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::_solve_impl ( const SparseMatrixBase< RhsDerived > &  b,
SparseMatrixBase< DestDerived > &  dest 
) const
inline

Definition at line 351 of file CholmodSupport.h.

◆ analyzePattern()

template<typename _MatrixType, int _UpLo, typename Derived>
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::analyzePattern ( const MatrixType matrix)
inline

Performs a symbolic decomposition on the sparsity pattern of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also
factorize()

Definition at line 286 of file CholmodSupport.h.

◆ cholmod()

template<typename _MatrixType, int _UpLo, typename Derived>
cholmod_common& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::cholmod ( )
inline

Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations. See the Cholmod user guide for details.

Definition at line 321 of file CholmodSupport.h.

◆ cols()

template<typename _MatrixType, int _UpLo, typename Derived>
StorageIndex Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::cols ( ) const
inline

Definition at line 258 of file CholmodSupport.h.

◆ compute()

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

Computes the sparse Cholesky decomposition of matrix

Definition at line 273 of file CholmodSupport.h.

◆ determinant()

template<typename _MatrixType, int _UpLo, typename Derived>
Scalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::determinant ( ) const
inline
Returns
the determinant of the underlying matrix from the current factorization

Definition at line 391 of file CholmodSupport.h.

◆ dumpMemory()

template<typename _MatrixType, int _UpLo, typename Derived>
template<typename Stream >
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::dumpMemory ( Stream &  )
inline

Definition at line 442 of file CholmodSupport.h.

◆ factorize()

template<typename _MatrixType, int _UpLo, typename Derived>
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::factorize ( const MatrixType matrix)
inline

Performs a numeric decomposition of matrix

The given matrix must have the same sparsity pattern as the matrix on which the symbolic decomposition has been performed.

See also
analyzePattern()

Definition at line 308 of file CholmodSupport.h.

◆ info()

template<typename _MatrixType, int _UpLo, typename Derived>
ComputationInfo Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::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 266 of file CholmodSupport.h.

◆ logDeterminant()

template<typename _MatrixType, int _UpLo, typename Derived>
Scalar Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::logDeterminant ( ) const
inline
Returns
the log determinant of the underlying matrix from the current factorization

Definition at line 398 of file CholmodSupport.h.

◆ rows()

template<typename _MatrixType, int _UpLo, typename Derived>
StorageIndex Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::rows ( ) const
inline

Definition at line 259 of file CholmodSupport.h.

◆ setShift()

template<typename _MatrixType, int _UpLo, typename Derived>
Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::setShift ( const RealScalar offset)
inline

Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.

During the numerical factorization, an offset term is added to the diagonal coefficients:
d_ii = offset + d_ii

The default is offset=0.

Returns
a reference to *this.

Definition at line 384 of file CholmodSupport.h.

Member Data Documentation

◆ m_analysisIsOk

template<typename _MatrixType, int _UpLo, typename Derived>
int Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_analysisIsOk
protected

Definition at line 451 of file CholmodSupport.h.

◆ m_cholmod

template<typename _MatrixType, int _UpLo, typename Derived>
cholmod_common Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_cholmod
mutableprotected

Definition at line 446 of file CholmodSupport.h.

◆ m_cholmodFactor

template<typename _MatrixType, int _UpLo, typename Derived>
cholmod_factor* Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_cholmodFactor
protected

Definition at line 447 of file CholmodSupport.h.

◆ m_factorizationIsOk

template<typename _MatrixType, int _UpLo, typename Derived>
int Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_factorizationIsOk
protected

Definition at line 450 of file CholmodSupport.h.

◆ m_info

template<typename _MatrixType, int _UpLo, typename Derived>
ComputationInfo Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_info
mutableprotected

Definition at line 449 of file CholmodSupport.h.

◆ m_shiftOffset

template<typename _MatrixType, int _UpLo, typename Derived>
double Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::m_shiftOffset[2]
protected

Definition at line 448 of file CholmodSupport.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:25