Public Member Functions | Protected Attributes
IterationController Class Reference

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

#include <IterationController.h>

List of all members.

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.
size_t m_nit
 iteration number
int m_noise
 if noise > 0 iterations are printed
double m_res
 last computed residual
double m_resadd
double m_resmax
 maximum residual
double m_resminreach
double m_rhsn
 Right hand side norm.
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 86 of file IterationController.h.


Constructor & Destructor Documentation

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

Definition at line 107 of file IterationController.h.


Member Function Documentation

bool IterationController::converged ( ) const [inline]

Definition at line 140 of file IterationController.h.

bool IterationController::converged ( double  nr) [inline]

Definition at line 141 of file IterationController.h.

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

Definition at line 147 of file IterationController.h.

bool IterationController::finished ( double  nr) [inline]

Definition at line 150 of file IterationController.h.

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

Definition at line 161 of file IterationController.h.

bool IterationController::first ( ) [inline]

Definition at line 113 of file IterationController.h.

void IterationController::init ( ) [inline]

Definition at line 100 of file IterationController.h.

size_t IterationController::iteration ( ) const [inline]

Definition at line 131 of file IterationController.h.

size_t IterationController::maxIterarions ( ) const [inline]

Definition at line 134 of file IterationController.h.

double IterationController::maxResidual ( ) const [inline]

Definition at line 120 of file IterationController.h.

int IterationController::noiseLevel ( ) const [inline]

Definition at line 116 of file IterationController.h.

void IterationController::operator++ ( int  ) [inline]

Definition at line 110 of file IterationController.h.

void IterationController::operator++ ( ) [inline]

Definition at line 111 of file IterationController.h.

Definition at line 118 of file IterationController.h.

double IterationController::residual ( ) const [inline]

Definition at line 123 of file IterationController.h.

double IterationController::rhsNorm ( ) const [inline]

Definition at line 137 of file IterationController.h.

void IterationController::setCallback ( void(*)(const IterationController &)  t) [inline]

Definition at line 126 of file IterationController.h.

void IterationController::setIteration ( size_t  i) [inline]

Definition at line 132 of file IterationController.h.

void IterationController::setMaxIterations ( size_t  i) [inline]

Definition at line 135 of file IterationController.h.

void IterationController::setMaxResidual ( double  r) [inline]

Definition at line 121 of file IterationController.h.

void IterationController::setNoiseLevel ( int  n) [inline]

Definition at line 117 of file IterationController.h.

void IterationController::setRhsNorm ( double  r) [inline]

Definition at line 138 of file IterationController.h.


Member Data Documentation

Definition at line 97 of file IterationController.h.

size_t IterationController::m_maxiter [protected]

Max. number of iterations.

Definition at line 90 of file IterationController.h.

size_t IterationController::m_nit [protected]

iteration number

Definition at line 94 of file IterationController.h.

if noise > 0 iterations are printed

Definition at line 91 of file IterationController.h.

double IterationController::m_res [protected]

last computed residual

Definition at line 95 of file IterationController.h.

double IterationController::m_resadd [protected]

Definition at line 93 of file IterationController.h.

double IterationController::m_resmax [protected]

maximum residual

Definition at line 92 of file IterationController.h.

Definition at line 93 of file IterationController.h.

double IterationController::m_rhsn [protected]

Right hand side norm.

Definition at line 89 of file IterationController.h.

Definition at line 96 of file IterationController.h.


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


libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:21