IncompleteCholesky< Scalar, _UpLo, _OrderingType > Class Template Reference

Detailed Description

template<typename Scalar, int _UpLo = Lower, typename _OrderingType = NaturalOrdering<int>>
class Eigen::IncompleteCholesky< Scalar, _UpLo, _OrderingType >

Modified Incomplete Cholesky with dual threshold.

References : C-J. Lin and J. J. Moré, Incomplete Cholesky Factorizations with Limited memory, SIAM J. Sci. Comput. 21(1), pp. 24-45, 1999

Template Parameters

_MatrixType	The type of the sparse matrix. It should be a symmetric matrix. It is advised to give a row-oriented sparse matrix
_UpLo	The triangular part of the matrix to reference.
_OrderingType

Inherits noncopyable.

Public Member Functions
template<typename MatrixType >
void	analyzePattern (const MatrixType &mat)
	Computes the fill reducing permutation vector.
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
void	setShift (Scalar shift)
	Set the initial shift parameter.

Member Function Documentation

ComputationInfo info ( ) const

inline

Reports whether previous computation was successful.

Returns

Success if computation was succesful, NumericalIssue if the matrix appears to be negative.

---

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

• IncompleteCholesky.h