Public Member Functions | Protected Types | Protected Attributes | List of all members
Eigen::SkylineInplaceLU< MatrixType > Class Template Reference

Inplace LU decomposition of a skyline matrix and associated features. More...

#include <SkylineInplaceLU.h>

Public Member Functions

void compute ()
 
void computeRowMajor ()
 
int flags () const
 
int orderingMethod () const
 
RealScalar precision () const
 
void setFlags (int f)
 
void setOrderingMethod (int m)
 
void setPrecision (RealScalar v)
 
 SkylineInplaceLU (MatrixType &matrix, int flags=0)
 
template<typename BDerived , typename XDerived >
bool solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > *x, const int transposed=0) const
 
bool succeeded (void) const
 

Protected Types

typedef MatrixType::Index Index
 
typedef NumTraits< typename MatrixType::Scalar >::Real RealScalar
 
typedef MatrixType::Scalar Scalar
 

Protected Attributes

int m_flags
 
MatrixTypem_lu
 
RealScalar m_precision
 
int m_status
 
bool m_succeeded
 

Detailed Description

template<typename MatrixType>
class Eigen::SkylineInplaceLU< MatrixType >

Inplace LU decomposition of a skyline matrix and associated features.

Parameters
MatrixTypethe type of the matrix of which we are computing the LU factorization

Definition at line 25 of file SkylineInplaceLU.h.

Member Typedef Documentation

◆ Index

template<typename MatrixType >
typedef MatrixType::Index Eigen::SkylineInplaceLU< MatrixType >::Index
protected

Definition at line 28 of file SkylineInplaceLU.h.

◆ RealScalar

template<typename MatrixType >
typedef NumTraits<typename MatrixType::Scalar>::Real Eigen::SkylineInplaceLU< MatrixType >::RealScalar
protected

Definition at line 30 of file SkylineInplaceLU.h.

◆ Scalar

template<typename MatrixType >
typedef MatrixType::Scalar Eigen::SkylineInplaceLU< MatrixType >::Scalar
protected

Definition at line 27 of file SkylineInplaceLU.h.

Constructor & Destructor Documentation

◆ SkylineInplaceLU()

template<typename MatrixType >
Eigen::SkylineInplaceLU< MatrixType >::SkylineInplaceLU ( MatrixType matrix,
int  flags = 0 
)
inline

Creates a LU object and compute the respective factorization of matrix using flags flags.

Definition at line 36 of file SkylineInplaceLU.h.

Member Function Documentation

◆ compute()

template<typename MatrixType >
void Eigen::SkylineInplaceLU< MatrixType >::compute ( )

Computes/re-computes the LU factorization

Computes / recomputes the in place LU decomposition of the SkylineInplaceLU. using the default algorithm.

Definition at line 120 of file SkylineInplaceLU.h.

◆ computeRowMajor()

template<typename MatrixType >
void Eigen::SkylineInplaceLU< MatrixType >::computeRowMajor ( )

Definition at line 184 of file SkylineInplaceLU.h.

◆ flags()

template<typename MatrixType >
int Eigen::SkylineInplaceLU< MatrixType >::flags ( ) const
inline
Returns
the current flags

Definition at line 76 of file SkylineInplaceLU.h.

◆ orderingMethod()

template<typename MatrixType >
int Eigen::SkylineInplaceLU< MatrixType >::orderingMethod ( ) const
inline

Definition at line 84 of file SkylineInplaceLU.h.

◆ precision()

template<typename MatrixType >
RealScalar Eigen::SkylineInplaceLU< MatrixType >::precision ( ) const
inline
Returns
the current precision.
See also
setPrecision()

Definition at line 59 of file SkylineInplaceLU.h.

◆ setFlags()

template<typename MatrixType >
void Eigen::SkylineInplaceLU< MatrixType >::setFlags ( int  f)
inline

Sets the flags. Possible values are:

  • CompleteFactorization
  • IncompleteFactorization
  • MemoryEfficient
  • one of the ordering methods
  • etc...
See also
flags()

Definition at line 71 of file SkylineInplaceLU.h.

◆ setOrderingMethod()

template<typename MatrixType >
void Eigen::SkylineInplaceLU< MatrixType >::setOrderingMethod ( int  m)
inline

Definition at line 80 of file SkylineInplaceLU.h.

◆ setPrecision()

template<typename MatrixType >
void Eigen::SkylineInplaceLU< MatrixType >::setPrecision ( RealScalar  v)
inline

Sets the relative threshold value used to prune zero coefficients during the decomposition.

Setting a value greater than zero speeds up computation, and yields to an incomplete factorization with fewer non zero coefficients. Such approximate factors are especially useful to initialize an iterative solver.

Note that the exact meaning of this parameter might depends on the actual backend. Moreover, not all backends support this feature.

See also
precision()

Definition at line 52 of file SkylineInplaceLU.h.

◆ solve()

template<typename MatrixType >
template<typename BDerived , typename XDerived >
bool Eigen::SkylineInplaceLU< MatrixType >::solve ( const MatrixBase< BDerived > &  b,
MatrixBase< XDerived > *  x,
const int  transposed = 0 
) const
Returns
the lower triangular matrix L
the upper triangular matrix U

Computes *x = U^-1 L^-1 b

If transpose is set to SvTranspose or SvAdjoint, the solution of the transposed/adjoint system is computed instead.

Not all backends implement the solution of the transposed or adjoint system.

Definition at line 307 of file SkylineInplaceLU.h.

◆ succeeded()

template<typename MatrixType >
bool Eigen::SkylineInplaceLU< MatrixType >::succeeded ( void  ) const
inline
Returns
true if the factorization succeeded

Definition at line 103 of file SkylineInplaceLU.h.

Member Data Documentation

◆ m_flags

template<typename MatrixType >
int Eigen::SkylineInplaceLU< MatrixType >::m_flags
protected

Definition at line 109 of file SkylineInplaceLU.h.

◆ m_lu

template<typename MatrixType >
MatrixType& Eigen::SkylineInplaceLU< MatrixType >::m_lu
protected

Definition at line 112 of file SkylineInplaceLU.h.

◆ m_precision

template<typename MatrixType >
RealScalar Eigen::SkylineInplaceLU< MatrixType >::m_precision
protected

Definition at line 108 of file SkylineInplaceLU.h.

◆ m_status

template<typename MatrixType >
int Eigen::SkylineInplaceLU< MatrixType >::m_status
mutableprotected

Definition at line 110 of file SkylineInplaceLU.h.

◆ m_succeeded

template<typename MatrixType >
bool Eigen::SkylineInplaceLU< MatrixType >::m_succeeded
protected

Definition at line 111 of file SkylineInplaceLU.h.


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


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