gko::stop::Iteration Class Reference

The Iteration class is a stopping criterion which stops the iteration process after a preset number of iterations. More...

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

Inheritance diagram for gko::stop::Iteration:

Collaboration diagram for gko::stop::Iteration:

Classes
class	Factory
struct	parameters_type

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

Static Public Member Functions
static auto	build () -> decltype(Factory ::create())

Friends
class	EnablePolymorphicObject< Iteration, Criterion >

Detailed Description

The Iteration class is a stopping criterion which stops the iteration process after a preset number of iterations.

Note

to use this stopping criterion, it is required to update the iteration count for the ::check() method.

---

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

• ginkgo/core/stop/iteration.hpp