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

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

Classes

class  Factory
 
struct  parameters_type
 

Public Member Functions

const parameters_typeget_parameters () const
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Combined, Criterion >
std::unique_ptr< Combined > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Combined > create_default () const
 
std::unique_ptr< Combined > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Combined > clone () const
 
Combined * copy_from (const PolymorphicObject *other)
 
Combined * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Combined * clear ()
 

Static Public Member Functions

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

Friends

class EnablePolymorphicObject< Combined, Criterion >
 

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: