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

Static Public Member Functions
static parameters_type	build ()

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