gko::stop::Combined Class Reference

The Combined class is used to combine multiple criterions together through an OR operation. More...

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

Inheritance diagram for gko::stop::Combined:

Collaboration diagram for gko::stop::Combined:

Classes
class	Factory
struct	parameters_type

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

Static Public Member Functions
static parameters_type	build ()

Friends
class	EnablePolymorphicObject< Combined, Criterion >

Detailed Description

The Combined class is used to combine multiple criterions together through an OR operation.

The typical use case is to stop the iteration process if any of the criteria is fulfilled, e.g. a number of iterations, the relative residual norm has reached a threshold, etc.

---

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

• ginkgo/core/stop/combined.hpp