Ginkgo  Generated from pipelines/375350765 branch based on develop. Ginkgo version 1.5.0
A numerical linear algebra library targeting many-core architectures
Classes | Public Member Functions | List of all members
gko::stop::Criterion Class Referenceabstract

The Criterion class is a base class for all stopping criteria. More...

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

Collaboration diagram for gko::stop::Criterion:
[legend]

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. 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::EnableAbstractPolymorphicObject< 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)
 
Criterion * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Criterion * clear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_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
 
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 
void clear_loggers () override
 

Detailed Description

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.

Member Function Documentation

◆ check()

bool gko::stop::Criterion::check ( uint8  stopping_id,
bool  set_finalized,
Array< stopping_status > *  stop_status,
bool *  one_changed,
const Updater updater 
)
inline

This checks whether convergence was reached for a certain criterion.

The actual implantation of the criterion goes here.

Parameters
stopping_idid of the stopping criterion
set_finalizedControls if the current version should count as finalized or not
stop_statusstatus of the stopping criterion
one_changedindicates if one vector's status changed
updaterthe Updater object containing all the information
Returns
whether convergence was completely reached

Referenced by gko::stop::Criterion::Updater::check().

◆ update()

Updater gko::stop::Criterion::update ( )
inline

Returns the updater object.

Returns
the updater object

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