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 >:

Friends
class	EnablePolymorphicObject< ResidualNormBase< ValueType >, Criterion >

Additional Inherited Members
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< ResidualNormBase< ValueType >, Criterion >
std::unique_ptr< ResidualNormBase< ValueType > >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< ResidualNormBase< ValueType > >	create_default () const
std::unique_ptr< ResidualNormBase< ValueType > >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< ResidualNormBase< ValueType > >	clone () const
ResidualNormBase< ValueType > *	copy_from (const PolymorphicObject *other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, ResidualNormBase< ValueType > > *	copy_from (std::unique_ptr< Derived > &&other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, ResidualNormBase< ValueType > > *	copy_from (const std::unique_ptr< Derived > &other)
ResidualNormBase< ValueType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
ResidualNormBase< ValueType > *	move_from (ptr_param< PolymorphicObject > other)
ResidualNormBase< ValueType > *	clear ()

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