Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Types | Protected Attributes
Eigen::SkylineInplaceLU< MatrixType > Class Template Reference

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 39 of file Skyline.

List of all members.

Public Member Functions

 SkylineInplaceLU (MatrixType &matrix, int flags=0)
 Creates a LU object and compute the respective factorization of matrix using flags flags.
void setPrecision (RealScalar v)
 Sets the relative threshold value used to prune zero coefficients during the decomposition.
RealScalar precision () const
void setFlags (int f)
 Sets the flags.
int flags () const
void setOrderingMethod (int m)
int orderingMethod () const
void compute ()
 Computes/re-computes the LU factorization.
void computeRowMajor ()
template<typename BDerived , typename XDerived >
bool solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > *x, const int transposed=0) const
 Computes *x = U^-1 L^-1 b.
bool succeeded (void) const

Protected Types

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

Protected Attributes

RealScalar m_precision
int m_flags
int m_status
bool m_succeeded
MatrixType & m_lu

Member Typedef Documentation

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

Definition at line 42 of file Skyline.

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

Definition at line 44 of file Skyline.

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

Definition at line 41 of file Skyline.


Constructor & Destructor Documentation

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 50 of file Skyline.


Member Function Documentation

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 134 of file Skyline.

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

Definition at line 198 of file Skyline.

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

Definition at line 90 of file Skyline.

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

Definition at line 98 of file Skyline.

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

Definition at line 73 of file Skyline.

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 85 of file Skyline.

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

Definition at line 94 of file Skyline.

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 imcomplete 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 66 of file Skyline.

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

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

Returns:
the lower triangular matrix L
the upper triangular matrix U

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 321 of file Skyline.

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

Definition at line 117 of file Skyline.


Member Data Documentation

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

Definition at line 123 of file Skyline.

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

Definition at line 126 of file Skyline.

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

Definition at line 122 of file Skyline.

template<typename MatrixType >
int Eigen::SkylineInplaceLU< MatrixType >::m_status [mutable, protected]

Definition at line 124 of file Skyline.

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

Definition at line 125 of file Skyline.




Page generated by Doxygen 1.7.4 for MRPT 0.9.5 SVN:2717 at Sun Oct 16 16:08:03 PDT 2011 Hosted on:
SourceForge.net Logo