Ginkgo  Generated from pipelines/2662685947 branch based on develop. Ginkgo version 2.0.0
A numerical linear algebra library targeting many-core architectures
Classes | Public Member Functions | Static Public Member Functions | List of all members
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:
[legend]
Collaboration diagram for gko::stop::Iteration:
[legend]

Classes

class  Factory
 
struct  parameters_type
 

Public Member Functions

const parameters_typeget_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
PolymorphicObjectoperator= (const PolymorphicObject &)
 
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
 
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 auto build () -> decltype(Factory ::create())
 

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: