A preconditioner based on the digonal entries. More...
#include <BasicPreconditioners.h>
Inheritance diagram for Eigen::DiagonalPreconditioner< _Scalar >:
Public Types | |
| enum | { ColsAtCompileTime = Dynamic , MaxColsAtCompileTime = Dynamic } |
| typedef Vector::StorageIndex | StorageIndex |
Public Member Functions | |
| DiagonalPreconditioner () | |
| template<typename MatType > | |
| DiagonalPreconditioner (const MatType &mat) | |
| EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
| EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
| template<typename MatType > | |
| DiagonalPreconditioner & | analyzePattern (const MatType &) |
| template<typename MatType > | |
| DiagonalPreconditioner & | factorize (const MatType &mat) |
| template<typename MatType > | |
| DiagonalPreconditioner & | compute (const MatType &mat) |
| template<typename Rhs , typename Dest > | |
| void | _solve_impl (const Rhs &b, Dest &x) const |
| template<typename Rhs > | |
| const Solve< DiagonalPreconditioner, Rhs > | solve (const MatrixBase< Rhs > &b) const |
| ComputationInfo | info () |
Protected Attributes | |
| Vector | m_invdiag |
| bool | m_isInitialized |
Private Types | |
| typedef _Scalar | Scalar |
| typedef Matrix< Scalar, Dynamic, 1 > | Vector |
Detailed Description
template<typename _Scalar>
class Eigen::DiagonalPreconditioner< _Scalar >
A preconditioner based on the digonal entries.
This class allows to approximately solve for A.x = b problems assuming A is a diagonal matrix. In other words, this preconditioner neglects all off diagonal entries and, in Eigen's language, solves for:
A.diagonal().asDiagonal() . x = b
- Template Parameters
-
_Scalar the type of the scalar.
\implsparsesolverconcept
This preconditioner is suitable for both selfadjoint and general problems. The diagonal entries are pre-inverted and stored into a dense vector.
- Note
- A variant that has yet to be implemented would attempt to preserve the norm of each column.
- See also
- class LeastSquareDiagonalPreconditioner, class ConjugateGradient
Member Typedef Documentation
◆ Scalar
template<typename _Scalar >
|
private |
◆ StorageIndex
template<typename _Scalar >
| typedef Vector::StorageIndex Eigen::DiagonalPreconditioner< _Scalar >::StorageIndex |
◆ Vector
template<typename _Scalar >
|
private |
Member Enumeration Documentation
◆ anonymous enum
Constructor & Destructor Documentation
◆ DiagonalPreconditioner() [1/2]
template<typename _Scalar >
|
inline |
◆ DiagonalPreconditioner() [2/2]
template<typename _Scalar >
template<typename MatType >
|
inlineexplicit |
Member Function Documentation
◆ _solve_impl()
template<typename _Scalar >
template<typename Rhs , typename Dest >
|
inline |
◆ analyzePattern()
template<typename _Scalar >
template<typename MatType >
|
inline |
◆ cols()
template<typename _Scalar >
|
inline |
◆ compute()
template<typename _Scalar >
template<typename MatType >
|
inline |
◆ factorize()
template<typename _Scalar >
template<typename MatType >
|
inline |
◆ info()
template<typename _Scalar >
|
inline |
◆ rows()
template<typename _Scalar >
|
inline |
◆ solve()
template<typename _Scalar >
template<typename Rhs >
|
inline |
Member Data Documentation
◆ m_invdiag
template<typename _Scalar >
|
protected |
◆ m_isInitialized
template<typename _Scalar >
|
protected |
The documentation for this class was generated from the following file:
- /home/runner/work/NDDEM/NDDEM/src/CoarseGraining/Eigen/src/IterativeLinearSolvers/BasicPreconditioners.h
