Eigen::SkylineInplaceLU< MatrixType > Class Template Reference

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

#include <SkylineInplaceLU.h>

Public Member Functions
	SkylineInplaceLU (MatrixType &matrix, int flags=0)
	Creates a LU object and compute the respective factorization of matrix using flags flags. More...
void	setPrecision (RealScalar v)
	Sets the relative threshold value used to prune zero coefficients during the decomposition. More...
RealScalar	precision () const
void	setFlags (int f)
	Sets the flags. More...
int	flags () const
void	setOrderingMethod (int m)
int	orderingMethod () const
void	compute ()
	Computes/re-computes the LU factorization. More...
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. More...
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

Detailed Description

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

Inplace LU decomposition of a skyline matrix and associated features.

Parameters

MatrixType

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

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.

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.

flags()

template<typename MatrixType >

int Eigen::SkylineInplaceLU< MatrixType >::flags ( ) const

inline

Returns

the current flags

precision()

template<typename MatrixType >

RealScalar Eigen::SkylineInplaceLU< MatrixType >::precision ( ) const

inline

Returns

the current precision.

See also

setPrecision()

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()

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 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()

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

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.

succeeded()

template<typename MatrixType >

bool Eigen::SkylineInplaceLU< MatrixType >::succeeded ( void  ) const

inline

Returns

true if the factorization succeeded

---

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

• third-party-libs/eigen3/unsupported/Eigen/src/Skyline/SkylineInplaceLU.h