Public Member Functions | Protected Attributes | List of all members
Eigen::IterationController Class Reference
Sparse linear algebra » Reference » IterativeLinearSolvers_Module

Controls the iterations of the iterative solvers. More...

#include <IterationController.h>

Public Member Functions

bool converged () const
 
bool converged (double nr)
 
template<typename VectorType >
bool converged (const VectorType &v)
 
bool finished (double nr)
 
template<typename VectorType >
bool finished (const MatrixBase< VectorType > &v)
 
bool first ()
 
void init ()
 
size_t iteration () const
 
 IterationController (double r=1.0E-8, int noi=0, size_t mit=size_t(-1))
 
size_t maxIterarions () const
 
double maxResidual () const
 
int noiseLevel () const
 
void operator++ (int)
 
void operator++ ()
 
void reduceNoiseLevel ()
 
double residual () const
 
double rhsNorm () const
 
void setCallback (void(*t)(const IterationController &))
 
void setIteration (size_t i)
 
void setMaxIterations (size_t i)
 
void setMaxResidual (double r)
 
void setNoiseLevel (int n)
 
void setRhsNorm (double r)
 

Protected Attributes

void(* m_callback )(const IterationController &)
 
size_t m_maxiter
 Max. number of iterations. More...
 
size_t m_nit
 iteration number More...
 
int m_noise
 if noise > 0 iterations are printed More...
 
double m_res
 last computed residual More...
 
double m_resadd
 
double m_resmax
 maximum residual More...
 
double m_resminreach
 
double m_rhsn
 Right hand side norm. More...
 
bool m_written
 

Detailed Description

Controls the iterations of the iterative solvers.

This class has been adapted from the iteration class of GMM++ and ITL libraries.

Definition at line 71 of file IterationController.h.

Constructor & Destructor Documentation

◆ IterationController()

Eigen::IterationController::IterationController ( double  r = 1.0E-8,
int  noi = 0,
size_t  mit = size_t(-1) 
)
inline

Definition at line 92 of file IterationController.h.

Member Function Documentation

◆ converged() [1/3]

bool Eigen::IterationController::converged ( ) const
inline

Definition at line 125 of file IterationController.h.

◆ converged() [2/3]

bool Eigen::IterationController::converged ( double  nr)
inline

Definition at line 126 of file IterationController.h.

◆ converged() [3/3]

template<typename VectorType >
bool Eigen::IterationController::converged ( const VectorType &  v)
inline

Definition at line 133 of file IterationController.h.

◆ finished() [1/2]

bool Eigen::IterationController::finished ( double  nr)
inline

Definition at line 136 of file IterationController.h.

◆ finished() [2/2]

template<typename VectorType >
bool Eigen::IterationController::finished ( const MatrixBase< VectorType > &  v)
inline

Definition at line 147 of file IterationController.h.

◆ first()

bool Eigen::IterationController::first ( )
inline

Definition at line 98 of file IterationController.h.

◆ init()

void Eigen::IterationController::init ( )
inline

Definition at line 85 of file IterationController.h.

◆ iteration()

size_t Eigen::IterationController::iteration ( ) const
inline

Definition at line 116 of file IterationController.h.

◆ maxIterarions()

size_t Eigen::IterationController::maxIterarions ( ) const
inline

Definition at line 119 of file IterationController.h.

◆ maxResidual()

double Eigen::IterationController::maxResidual ( ) const
inline

Definition at line 105 of file IterationController.h.

◆ noiseLevel()

int Eigen::IterationController::noiseLevel ( ) const
inline

Definition at line 101 of file IterationController.h.

◆ operator++() [1/2]

void Eigen::IterationController::operator++ ( int  )
inline

Definition at line 95 of file IterationController.h.

◆ operator++() [2/2]

void Eigen::IterationController::operator++ ( )
inline

Definition at line 96 of file IterationController.h.

◆ reduceNoiseLevel()

void Eigen::IterationController::reduceNoiseLevel ( )
inline

Definition at line 103 of file IterationController.h.

◆ residual()

double Eigen::IterationController::residual ( ) const
inline

Definition at line 108 of file IterationController.h.

◆ rhsNorm()

double Eigen::IterationController::rhsNorm ( ) const
inline

Definition at line 122 of file IterationController.h.

◆ setCallback()

void Eigen::IterationController::setCallback ( void(*)(const IterationController &)  t)
inline

Definition at line 111 of file IterationController.h.

◆ setIteration()

void Eigen::IterationController::setIteration ( size_t  i)
inline

Definition at line 117 of file IterationController.h.

◆ setMaxIterations()

void Eigen::IterationController::setMaxIterations ( size_t  i)
inline

Definition at line 120 of file IterationController.h.

◆ setMaxResidual()

void Eigen::IterationController::setMaxResidual ( double  r)
inline

Definition at line 106 of file IterationController.h.

◆ setNoiseLevel()

void Eigen::IterationController::setNoiseLevel ( int  n)
inline

Definition at line 102 of file IterationController.h.

◆ setRhsNorm()

void Eigen::IterationController::setRhsNorm ( double  r)
inline

Definition at line 123 of file IterationController.h.

Member Data Documentation

◆ m_callback

void(* Eigen::IterationController::m_callback) (const IterationController &)
protected

Definition at line 82 of file IterationController.h.

◆ m_maxiter

size_t Eigen::IterationController::m_maxiter
protected

Max. number of iterations.

Definition at line 75 of file IterationController.h.

◆ m_nit

size_t Eigen::IterationController::m_nit
protected

iteration number

Definition at line 79 of file IterationController.h.

◆ m_noise

int Eigen::IterationController::m_noise
protected

if noise > 0 iterations are printed

Definition at line 76 of file IterationController.h.

◆ m_res

double Eigen::IterationController::m_res
protected

last computed residual

Definition at line 80 of file IterationController.h.

◆ m_resadd

double Eigen::IterationController::m_resadd
protected

Definition at line 78 of file IterationController.h.

◆ m_resmax

double Eigen::IterationController::m_resmax
protected

maximum residual

Definition at line 77 of file IterationController.h.

◆ m_resminreach

double Eigen::IterationController::m_resminreach
protected

Definition at line 78 of file IterationController.h.

◆ m_rhsn

double Eigen::IterationController::m_rhsn
protected

Right hand side norm.

Definition at line 74 of file IterationController.h.

◆ m_written

bool Eigen::IterationController::m_written
protected

Definition at line 81 of file IterationController.h.

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

gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:48