Public Member Functions | Protected Attributes
Eigen::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 75 of file IterationController.h.


Constructor & Destructor Documentation

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

Definition at line 96 of file IterationController.h.


Member Function Documentation

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

Definition at line 129 of file IterationController.h.

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

Definition at line 130 of file IterationController.h.

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

Definition at line 136 of file IterationController.h.

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

Definition at line 139 of file IterationController.h.

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

Definition at line 150 of file IterationController.h.

Definition at line 102 of file IterationController.h.

Definition at line 89 of file IterationController.h.

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

Definition at line 120 of file IterationController.h.

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

Definition at line 123 of file IterationController.h.

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

Definition at line 109 of file IterationController.h.

Definition at line 105 of file IterationController.h.

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

Definition at line 99 of file IterationController.h.

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

Definition at line 100 of file IterationController.h.

Definition at line 107 of file IterationController.h.

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

Definition at line 112 of file IterationController.h.

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

Definition at line 126 of file IterationController.h.

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

Definition at line 115 of file IterationController.h.

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

Definition at line 121 of file IterationController.h.

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

Definition at line 124 of file IterationController.h.

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

Definition at line 110 of file IterationController.h.

Definition at line 106 of file IterationController.h.

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

Definition at line 127 of file IterationController.h.


Member Data Documentation

Definition at line 86 of file IterationController.h.

Max. number of iterations.

Definition at line 79 of file IterationController.h.

iteration number

Definition at line 83 of file IterationController.h.

if noise > 0 iterations are printed

Definition at line 80 of file IterationController.h.

last computed residual

Definition at line 84 of file IterationController.h.

Definition at line 82 of file IterationController.h.

maximum residual

Definition at line 81 of file IterationController.h.

Definition at line 82 of file IterationController.h.

Right hand side norm.

Definition at line 78 of file IterationController.h.

Definition at line 85 of file IterationController.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:14