Eigen::IterationController Class Reference

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

#include <IterationController.h>

Public Member Functions
void	init ()
	IterationController (double r=1.0E-8, int noi=0, size_t mit=size_t(-1))
void	operator++ (int)
void	operator++ ()
bool	first ()
int	noiseLevel () const
void	setNoiseLevel (int n)
void	reduceNoiseLevel ()
double	maxResidual () const
void	setMaxResidual (double r)
double	residual () const
void	setCallback (void(*t)(const IterationController &))
size_t	iteration () const
void	setIteration (size_t i)
size_t	maxIterarions () const
void	setMaxIterations (size_t i)
double	rhsNorm () const
void	setRhsNorm (double r)
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)

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

Detailed Description

Controls the iterations of the iterative solvers.

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

Constructor & Destructor Documentation

IterationController()

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

inline

Member Function Documentation

converged() [1/3]

bool Eigen::IterationController::converged ( ) const

inline

converged() [2/3]

template<typename VectorType >

bool Eigen::IterationController::converged ( const VectorType &  v )

inline

converged() [3/3]

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

inline

finished() [1/2]

template<typename VectorType >

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

inline

finished() [2/2]

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

inline

first()

bool Eigen::IterationController::first ( )

inline

init()

void Eigen::IterationController::init ( )

inline

iteration()

size_t Eigen::IterationController::iteration ( ) const

inline

maxIterarions()

size_t Eigen::IterationController::maxIterarions ( ) const

inline

maxResidual()

double Eigen::IterationController::maxResidual ( ) const

inline

noiseLevel()

int Eigen::IterationController::noiseLevel ( ) const

inline

operator++() [1/2]

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

inline

operator++() [2/2]

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

inline

reduceNoiseLevel()

void Eigen::IterationController::reduceNoiseLevel ( )

inline

residual()

double Eigen::IterationController::residual ( ) const

inline

rhsNorm()

double Eigen::IterationController::rhsNorm ( ) const

inline

setCallback()

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

inline

setIteration()

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

inline

setMaxIterations()

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

inline

setMaxResidual()

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

inline

setNoiseLevel()

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

inline

setRhsNorm()

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

inline

Member Data Documentation

m_callback

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

protected

m_maxiter

size_t Eigen::IterationController::m_maxiter

protected

Max. number of iterations.

m_nit

size_t Eigen::IterationController::m_nit

protected

iteration number

m_noise

int Eigen::IterationController::m_noise

protected

if noise > 0 iterations are printed

m_res

double Eigen::IterationController::m_res

protected

last computed residual

m_resadd

double Eigen::IterationController::m_resadd

protected

m_resmax

double Eigen::IterationController::m_resmax

protected

maximum residual

m_resminreach

double Eigen::IterationController::m_resminreach

protected

m_rhsn

double Eigen::IterationController::m_rhsn

protected

Right hand side norm.

m_written

bool Eigen::IterationController::m_written

protected

---

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

• core/util/algorithms/eigen-3.4.0/unsupported/Eigen/src/IterativeSolvers/IterationController.h