Eigen::IdentityPreconditioner Class Reference

A naive preconditioner which approximates any matrix as the identity matrix. More...

#include <BasicPreconditioners.h>

Public Member Functions

 IdentityPreconditioner ()
 
template<typename MatrixType >
 IdentityPreconditioner (const MatrixType &)
 
template<typename MatrixType >
IdentityPreconditioneranalyzePattern (const MatrixType &)
 
template<typename MatrixType >
IdentityPreconditionerfactorize (const MatrixType &)
 
template<typename MatrixType >
IdentityPreconditionercompute (const MatrixType &)
 
template<typename Rhs >
const Rhs & solve (const Rhs &b) const
 
ComputationInfo info ()
 

Detailed Description

A naive preconditioner which approximates any matrix as the identity matrix.

\implsparsesolverconcept

See also
class DiagonalPreconditioner

Constructor & Destructor Documentation

◆ IdentityPreconditioner() [1/2]

Eigen::IdentityPreconditioner::IdentityPreconditioner ( )
inline
183 {}

◆ IdentityPreconditioner() [2/2]

template<typename MatrixType >
Eigen::IdentityPreconditioner::IdentityPreconditioner ( const MatrixType )
inlineexplicit
186 {}

Member Function Documentation

◆ analyzePattern()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::analyzePattern ( const MatrixType )
inline
189  {
190  return *this;
191  }

◆ compute()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::compute ( const MatrixType )
inline
199  {
200  return *this;
201  }

◆ factorize()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::factorize ( const MatrixType )
inline
194  {
195  return *this;
196  }

◆ info()

ComputationInfo Eigen::IdentityPreconditioner::info ( )
inline
208 { return Success; }
@ Success
Definition: Constants.h:440

References Eigen::Success.

◆ solve()

template<typename Rhs >
const Rhs& Eigen::IdentityPreconditioner::solve ( const Rhs &  b) const
inline
204  {
205  return b;
206  }
Scalar * b
Definition: benchVecAdd.cpp:17

References b.


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