Ginkgo  Generated from pipelines/130473384 branch based on develop. Ginkgo version 1.1.1
A numerical linear algebra library targeting many-core architectures
Classes | Public Member Functions | Static Public Member Functions | Friends | 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>

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::EnableAbstractPolymorphicObject< Iteration, Criterion >
std::unique_ptr< Iteration > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Iteration > create_default () const
 
std::unique_ptr< Iteration > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Iteration > clone () const
 
Iteration * copy_from (const PolymorphicObject *other)
 
Iteration * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Iteration * clear ()
 

Static Public Member Functions

static auto build () -> decltype(Factory ::create())
 

Friends

class EnablePolymorphicObject< Iteration, Criterion >
 

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: