Eigen::IdentityPreconditioner Class Reference

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

Public Member Functions

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

Detailed Description

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

This class follows the sparse solver concept .

See also
class DiagonalPreconditioner

Definition at line 202 of file BasicPreconditioners.h.

Constructor & Destructor Documentation

◆ IdentityPreconditioner() [1/2]

Eigen::IdentityPreconditioner::IdentityPreconditioner ( )
inline

Definition at line 206 of file BasicPreconditioners.h.

206 {}

◆ IdentityPreconditioner() [2/2]

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

Definition at line 209 of file BasicPreconditioners.h.

209 {}

Member Function Documentation

◆ analyzePattern()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::analyzePattern ( const MatrixType )
inline

Definition at line 212 of file BasicPreconditioners.h.

212 { return *this; }

◆ compute()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::compute ( const MatrixType )
inline

Definition at line 218 of file BasicPreconditioners.h.

218 { return *this; }

◆ factorize()

template<typename MatrixType >
IdentityPreconditioner& Eigen::IdentityPreconditioner::factorize ( const MatrixType )
inline

Definition at line 215 of file BasicPreconditioners.h.

215 { return *this; }

◆ info()

ComputationInfo Eigen::IdentityPreconditioner::info ( )
inline

Definition at line 223 of file BasicPreconditioners.h.

223 { return Success; }
@ Success
Definition: Constants.h:446

◆ solve()

template<typename Rhs >
const Rhs& Eigen::IdentityPreconditioner::solve ( const Rhs &  b) const
inline

Definition at line 221 of file BasicPreconditioners.h.

221 { return b; }
Array< int, 3, 1 > b

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