cusp::default_monitor< ValueType > Class Template Reference

#include <monitor.h>

Inheritance diagram for cusp::default_monitor< ValueType >:

Public Types
typedef Parent::Real	Real
	A real-valued type used for norms and tolerances.
Public Types inherited from cusp::monitor< ValueType >
typedef cusp::norm_type< ValueType >::type	Real
	A real-valued type used for norms and tolerances.

Public Methods
template<typename VectorType >
CUSP_DEPRECATED	default_monitor (const VectorType &b, const size_t iteration_limit=500, const Real relative_tolerance=1e-5, const Real absolute_tolerance=0)
	Constructs a default_monitor for a given right-hand-side b.
Public Methods inherited from cusp::monitor< ValueType >
template<typename VectorType >
	monitor (const VectorType &b, const size_t iteration_limit=500, const Real relative_tolerance=1e-5, const Real absolute_tolerance=0, const bool verbose=false)
	Constructs a monitor for a given right-hand-side b.
void	operator++ (void)
	Increments the iteration count.
bool	converged (void) const
	Indicates whether the last tested residual satisfies the convergence tolerance.
Real	residual_norm (void) const
	Euclidean norm of last residual.
size_t	iteration_count (void) const
	Returns the number of iterations that the monitor has executed.
size_t	iteration_limit (void) const
	Returns the maximum number of iterations.
Real	relative_tolerance (void) const
	Returns the relative tolerance.
Real	absolute_tolerance (void) const
	Returns the absolute tolerance.
Real	tolerance (void) const
	Return the tolerance equal to absolute_tolerance() + relative_tolerance() * ||b||.
template<typename Vector >
bool	finished (const Vector &r)
	Applies convergence criteria to determine whether iteration is finished.
template<typename DerivedPolicy , typename Vector >
bool	finished (thrust::execution_policy< DerivedPolicy > &exec, const Vector &r)
	Applies convergence criteria using an explicit execution policy.
void	set_verbose (bool verbose_=true)
	Sets the verbosity level of the monitor.
bool	is_verbose (void)
	Gets the verbosity level of the monitor.
template<typename Vector >
void	reset (const Vector &b)
	Resets the monitor using same convergence criteria.
void	print (void)
	Prints the number of iterations and convergence history information.
Real	immediate_rate (void)
	Returns the immediate convergence rate.
Real	geometric_rate (void)
	Returns the geometric convergence rate.
Real	average_rate (void)
	Returns the average convergence rate.

Additional Inherited Members
Public Members inherited from cusp::monitor< ValueType >
cusp::array1d< Real, cusp::host_memory >	residuals
	Array holding the residuals per iteration.

Detailed description

template<typename ValueType>
class cusp::default_monitor< ValueType >

Deprecated default monitor.

Deprecated:

As of v0.4.0 monitors have been unified. Use monitor instead.

Definition at line 311 of file monitor.h.