Incomplete LU factorization with dual-threshold strategy. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/IterativeLinearSolvers/IncompleteLUT.h>

Inheritance diagram for Eigen::IncompleteLUT< _Scalar, _StorageIndex >:

Classes
struct	keep_diag
	keeps off-diagonal entries; drops diagonal entries More...

Public Types
enum	{ ColsAtCompileTime = Dynamic , MaxColsAtCompileTime = Dynamic }

typedef _Scalar	Scalar

typedef _StorageIndex	StorageIndex

typedef NumTraits< Scalar >::Real	RealScalar

typedef Matrix< Scalar, Dynamic, 1 >	Vector

typedef Matrix< StorageIndex, Dynamic, 1 >	VectorI

typedef SparseMatrix< Scalar, RowMajor, StorageIndex >	FactorType

Public Member Functions
	IncompleteLUT ()

template<typename MatrixType >
	IncompleteLUT (const MatrixType &mat, const RealScalar &droptol=NumTraits< Scalar >::dummy_precision(), int fillfactor=10)

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

template<typename MatrixType >
void	analyzePattern (const MatrixType &amat)

template<typename MatrixType >
void	factorize (const MatrixType &amat)

template<typename MatrixType >
IncompleteLUT &	compute (const MatrixType &amat)
	Compute an incomplete LU factorization with dual threshold on the matrix mat No pivoting is done in this version. More...

void	setDroptol (const RealScalar &droptol)
	Set control parameter droptol. More...

void	setFillfactor (int fillfactor)
	Set control parameter fillfactor. More...

template<typename Rhs , typename Dest >
void	_solve_impl (const Rhs &b, Dest &x) const

template<typename _MatrixType >
void	analyzePattern (const _MatrixType &amat)

template<typename _MatrixType >
void	factorize (const _MatrixType &amat)

Public Member Functions inherited from Eigen::SparseSolverBase< IncompleteLUT< _Scalar, int > >
	SparseSolverBase ()
	Default constructor. More...

	~SparseSolverBase ()

IncompleteLUT< _Scalar, int > &	derived ()

const IncompleteLUT< _Scalar, int > &	derived () const

const Solve< IncompleteLUT< _Scalar, int >, Rhs >	solve (const MatrixBase< Rhs > &b) const

const Solve< IncompleteLUT< _Scalar, int >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Types
typedef SparseSolverBase< IncompleteLUT >	Base

Protected Attributes
FactorType	m_lu

RealScalar	m_droptol

int	m_fillfactor

bool	m_analysisIsOk

bool	m_factorizationIsOk

ComputationInfo	m_info

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_P

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_Pinv

bool	m_isInitialized

Protected Attributes inherited from Eigen::SparseSolverBase< IncompleteLUT< _Scalar, int > >
bool	m_isInitialized

Detailed Description

template<typename _Scalar, typename _StorageIndex = int>
class Eigen::IncompleteLUT< _Scalar, _StorageIndex >

Incomplete LU factorization with dual-threshold strategy.

\implsparsesolverconcept

During the numerical factorization, two dropping rules are used : 1) any element whose magnitude is less than some tolerance is dropped. This tolerance is obtained by multiplying the input tolerance droptol by the average magnitude of all the original elements in the current row. 2) After the elimination of the row, only the fill largest elements in the L part and the fill largest elements in the U part are kept (in addition to the diagonal element ). Note that fill is computed from the input parameter fillfactor which is used the ratio to control the fill_in relatively to the initial number of nonzero elements.

The two extreme cases are when droptol=0 (to keep all the fill*2 largest elements) and when fill=n/2 with droptol being different to zero.

References : Yousef Saad, ILUT: A dual threshold incomplete LU factorization, Numerical Linear Algebra with Applications, 1(4), pp 387-402, 1994.

NOTE : The following implementation is derived from the ILUT implementation in the SPARSKIT package, Copyright (C) 2005, the Regents of the University of Minnesota released under the terms of the GNU LGPL: http://www-users.cs.umn.edu/~saad/software/SPARSKIT/README However, Yousef Saad gave us permission to relicense his ILUT code to MPL2. See the Eigen mailing list archive, thread: ILUT, date: July 8, 2012: http://listengine.tuxfamily.org/lists.tuxfamily.org/eigen/2012/07/msg00064.html alternatively, on GMANE: http://comments.gmane.org/gmane.comp.lib.eigen/3302

Member Typedef Documentation

◆ Base

template<typename _Scalar , typename _StorageIndex = int>

typedef SparseSolverBase<IncompleteLUT> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::Base

protected

◆ FactorType

template<typename _Scalar , typename _StorageIndex = int>

typedef SparseMatrix<Scalar,RowMajor,StorageIndex> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::FactorType

◆ RealScalar

template<typename _Scalar , typename _StorageIndex = int>

typedef NumTraits<Scalar>::Real Eigen::IncompleteLUT< _Scalar, _StorageIndex >::RealScalar

◆ Scalar

template<typename _Scalar , typename _StorageIndex = int>

typedef _Scalar Eigen::IncompleteLUT< _Scalar, _StorageIndex >::Scalar

◆ StorageIndex

template<typename _Scalar , typename _StorageIndex = int>

typedef _StorageIndex Eigen::IncompleteLUT< _Scalar, _StorageIndex >::StorageIndex

◆ Vector

template<typename _Scalar , typename _StorageIndex = int>

typedef Matrix<Scalar,Dynamic,1> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::Vector

◆ VectorI

template<typename _Scalar , typename _StorageIndex = int>

typedef Matrix<StorageIndex,Dynamic,1> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::VectorI

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , typename _StorageIndex = int>

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime

Constructor & Destructor Documentation

◆ IncompleteLUT() [1/2]

template<typename _Scalar , typename _StorageIndex = int>

Eigen::IncompleteLUT< _Scalar, _StorageIndex >::IncompleteLUT ( )

inline

◆ IncompleteLUT() [2/2]

template<typename _Scalar , typename _StorageIndex = int>

template<typename MatrixType >

Eigen::IncompleteLUT< _Scalar, _StorageIndex >::IncompleteLUT	(	const MatrixType &	mat,
		const RealScalar &	droptol = `NumTraits<Scalar>::dummy_precision()`,
		int	fillfactor = `10`
	)

inlineexplicit

Member Function Documentation

◆ _solve_impl()

template<typename _Scalar , typename _StorageIndex = int>

template<typename Rhs , typename Dest >

void Eigen::IncompleteLUT< _Scalar, _StorageIndex >::_solve_impl	(	const Rhs &	b,
		Dest &	x
	)		const

inline

◆ analyzePattern() [1/2]

template<typename _Scalar , typename _StorageIndex = int>

template<typename _MatrixType >

void Eigen::IncompleteLUT< _Scalar, _StorageIndex >::analyzePattern ( const _MatrixType & amat )

◆ analyzePattern() [2/2]

template<typename _Scalar , typename _StorageIndex = int>

template<typename MatrixType >

void Eigen::IncompleteLUT< _Scalar, _StorageIndex >::analyzePattern ( const MatrixType & amat )

◆ cols()

template<typename _Scalar , typename _StorageIndex = int>

EIGEN_CONSTEXPR Index Eigen::IncompleteLUT< _Scalar, _StorageIndex >::cols ( ) const

inline

◆ compute()

template<typename _Scalar , typename _StorageIndex = int>

template<typename MatrixType >

IncompleteLUT & Eigen::IncompleteLUT< _Scalar, _StorageIndex >::compute ( const MatrixType & amat )

inline

Compute an incomplete LU factorization with dual threshold on the matrix mat No pivoting is done in this version.

◆ factorize() [1/2]

template<typename _Scalar , typename _StorageIndex = int>

template<typename _MatrixType >

void Eigen::IncompleteLUT< _Scalar, _StorageIndex >::factorize ( const _MatrixType & amat )

◆ factorize() [2/2]

template<typename _Scalar , typename _StorageIndex = int>

template<typename MatrixType >

void Eigen::IncompleteLUT< _Scalar, _StorageIndex >::factorize ( const MatrixType & amat )

◆ info()

template<typename _Scalar , typename _StorageIndex = int>

ComputationInfo Eigen::IncompleteLUT< _Scalar, _StorageIndex >::info ( ) const

inline

Reports whether previous computation was successful.

Returns: Success if computation was successful, NumericalIssue if the matrix.appears to be negative.

◆ rows()

template<typename _Scalar , typename _StorageIndex = int>

EIGEN_CONSTEXPR Index Eigen::IncompleteLUT< _Scalar, _StorageIndex >::rows ( ) const

inline

◆ setDroptol()

template<typename Scalar , typename StorageIndex >

void Eigen::IncompleteLUT< Scalar, StorageIndex >::setDroptol ( const RealScalar & droptol )

Set control parameter droptol.

Parameters

droptol Drop any element whose magnitude is less than this tolerance

◆ setFillfactor()

template<typename Scalar , typename StorageIndex >

void Eigen::IncompleteLUT< Scalar, StorageIndex >::setFillfactor ( int fillfactor )

Set control parameter fillfactor.

Parameters

fillfactor This is used to compute the number fill_in of largest elements to keep on each row.

Member Data Documentation

◆ m_analysisIsOk

template<typename _Scalar , typename _StorageIndex = int>

bool Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_analysisIsOk

protected

◆ m_droptol

template<typename _Scalar , typename _StorageIndex = int>

RealScalar Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_droptol

protected

◆ m_factorizationIsOk

template<typename _Scalar , typename _StorageIndex = int>

bool Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_factorizationIsOk

protected

◆ m_fillfactor

template<typename _Scalar , typename _StorageIndex = int>

int Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_fillfactor

protected

◆ m_info

template<typename _Scalar , typename _StorageIndex = int>

ComputationInfo Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_info

protected

◆ m_isInitialized

template<typename _Scalar , typename _StorageIndex = int>

bool Eigen::SparseSolverBase< Derived >::m_isInitialized

mutableprotected

◆ m_lu

template<typename _Scalar , typename _StorageIndex = int>

FactorType Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_lu

protected

◆ m_P

template<typename _Scalar , typename _StorageIndex = int>

PermutationMatrix<Dynamic,Dynamic,StorageIndex> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_P

protected

◆ m_Pinv

template<typename _Scalar , typename _StorageIndex = int>

PermutationMatrix<Dynamic,Dynamic,StorageIndex> Eigen::IncompleteLUT< _Scalar, _StorageIndex >::m_Pinv

protected

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

/home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/IterativeLinearSolvers/IncompleteLUT.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Base

◆ FactorType

◆ RealScalar

◆ Scalar

◆ StorageIndex

◆ Vector

◆ VectorI

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ IncompleteLUT() [1/2]

◆ IncompleteLUT() [2/2]

Member Function Documentation

◆ _solve_impl()

◆ analyzePattern() [1/2]

◆ analyzePattern() [2/2]

◆ cols()

◆ compute()

◆ factorize() [1/2]

◆ factorize() [2/2]

◆ info()

◆ rows()

◆ setDroptol()

◆ setFillfactor()

Member Data Documentation

◆ m_analysisIsOk

◆ m_droptol

◆ m_factorizationIsOk

◆ m_fillfactor

◆ m_info

◆ m_isInitialized

◆ m_lu

◆ m_P

◆ m_Pinv