spike::Monitor< SolverVector > Class Template Reference

#include <monitor.h>

Public Types
enum	State { Continue, Converged, Failed }
typedef SolverVector::value_type	SolverValueType

Public Member Functions
	Monitor (const int maxIterations, const SolverValueType tolerance)
	~Monitor ()
void	init (const SolverVector &rhs)
bool	done (const SolverVector &r)
void	increment (float incr)
bool	converged () const
int	getMaxIterations () const
float	getNumIterations () const
SolverValueType	getTolerance () const
SolverValueType	getRHSNorm () const
SolverValueType	getResidualNorm () const
SolverValueType	getRelResidualNorm () const

Member Typedef Documentation

template<typename SolverVector>

typedef SolverVector::value_type spike::Monitor< SolverVector >::SolverValueType

Member Enumeration Documentation

template<typename SolverVector>

enum spike::Monitor::State

Enumerator
Continue
Converged
Failed

Constructor & Destructor Documentation

template<typename SolverVector >

spike::Monitor< SolverVector >::Monitor ( const int  maxIterations, const SolverValueType  tolerance  )

inline

template<typename SolverVector>

spike::Monitor< SolverVector >::~Monitor ( )

inline

Member Function Documentation

template<typename SolverVector>

bool spike::Monitor< SolverVector >::converged ( ) const

inline

template<typename SolverVector >

bool spike::Monitor< SolverVector >::done ( const SolverVector &  r )

inline

template<typename SolverVector>

int spike::Monitor< SolverVector >::getMaxIterations ( ) const

inline

template<typename SolverVector>

float spike::Monitor< SolverVector >::getNumIterations ( ) const

inline

template<typename SolverVector>

SolverValueType spike::Monitor< SolverVector >::getRelResidualNorm ( ) const

inline

template<typename SolverVector>

SolverValueType spike::Monitor< SolverVector >::getResidualNorm ( ) const

inline

template<typename SolverVector>

SolverValueType spike::Monitor< SolverVector >::getRHSNorm ( ) const

inline

template<typename SolverVector>

SolverValueType spike::Monitor< SolverVector >::getTolerance ( ) const

inline

template<typename SolverVector>

void spike::Monitor< SolverVector >::increment ( float  incr )

inline

template<typename SolverVector >

void spike::Monitor< SolverVector >::init ( const SolverVector &  rhs )

inline

---

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

• C:/Users/Radu Serban/Repositories/SpikeLibrary/spike/monitor.h