![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
|
The Criterion class is a base class for all stopping criteria. More...
#include <ginkgo/core/stop/criterion.hpp>
Classes | |
class | Updater |
The Updater class serves for convenient argument passing to the Criterion's check function. More... | |
Public Member Functions | |
Updater | update () |
Returns the updater object. | |
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. | |
![]() | |
std::unique_ptr< Criterion > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< Criterion > | create_default () const |
std::unique_ptr< Criterion > | clone (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< Criterion > | clone () const |
Criterion * | copy_from (const PolymorphicObject *other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Criterion > * | copy_from (std::unique_ptr< Derived > &&other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Criterion > * | copy_from (const std::unique_ptr< Derived > &other) |
Criterion * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Criterion * | move_from (ptr_param< PolymorphicObject > other) |
Criterion * | clear () |
![]() | |
PolymorphicObject & | operator= (const PolymorphicObject &) |
std::unique_ptr< PolymorphicObject > | create_default (std::shared_ptr< const Executor > exec) const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | create_default () const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
Creates a clone of the object. | |
std::unique_ptr< PolymorphicObject > | clone () const |
Creates a clone of the object. | |
PolymorphicObject * | copy_from (const PolymorphicObject *other) |
Copies another object into this object. | |
template<typename Derived , typename Deleter > | |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (std::unique_ptr< Derived, Deleter > &&other) |
Moves another object into this object. | |
template<typename Derived , typename Deleter > | |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (const std::unique_ptr< Derived, Deleter > &other) |
Copies another object into this object. | |
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Copies another object into this object. | |
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
Moves another object into this object. | |
PolymorphicObject * | clear () |
Transforms the object into its default state. | |
std::shared_ptr< const Executor > | get_executor () const noexcept |
Returns the Executor of the object. | |
![]() | |
void | add_logger (std::shared_ptr< const Logger > logger) override |
Adds a new logger to the list of subscribed loggers. | |
void | remove_logger (const Logger *logger) override |
Removes a logger from the list of subscribed loggers. | |
void | remove_logger (ptr_param< const Logger > logger) |
const std::vector< std::shared_ptr< const Logger > > & | get_loggers () const override |
Returns the vector containing all loggers registered at this object. | |
void | clear_loggers () override |
Remove all loggers registered at this object. | |
![]() | |
void | remove_logger (ptr_param< const Logger > logger) |
The Criterion class is a base class for all stopping criteria.
It contains a factory to instantiate criteria. It is up to each specific stopping criterion to decide what to do with the data that is passed to it.
Note that depending on the criterion, convergence may not have happened after stopping.
|
inline |
This checks whether convergence was reached for a certain criterion.
The actual implantation of the criterion goes here.
stopping_id | id of the stopping criterion |
set_finalized | Controls if the current version should count as finalized or not |
stop_status | status of the stopping criterion |
one_changed | indicates if the status of a vector has changed |
updater | the Updater object containing all the information |
Referenced by gko::stop::Criterion::Updater::check().
|
inline |
Returns the updater object.