gko::stop::ResidualNormBase< ValueType > Class Template Reference

The ResidualNormBase class provides a framework for stopping criteria related to the residual norm. More...

#include <ginkgo/core/stop/residual_norm.hpp>

Inheritance diagram for gko::stop::ResidualNormBase< ValueType >:

Collaboration diagram for gko::stop::ResidualNormBase< ValueType >:

Additional Inherited Members
Public Member Functions inherited from gko::stop::Criterion
Updater	update ()
	Returns the updater object. More...
bool	check (uint8 stopping_id, bool set_finalized, array< stopping_status > *stop_status, bool *one_changed, const Updater &updater)
	This checks whether convergence was reached for a certain criterion. More...
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override
void	remove_logger (const Logger *logger) override
void	remove_logger (ptr_param< const Logger > logger)
const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override
void	clear_loggers () override
Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Detailed Description

template<typename ValueType>
class gko::stop::ResidualNormBase< ValueType >

The ResidualNormBase class provides a framework for stopping criteria related to the residual norm.

These criteria differ in the way they initialize starting_tau_, so in the value they compare the residual norm against. The provided check_impl uses the actual residual to check for convergence.

---

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

• ginkgo/core/stop/residual_norm.hpp