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 Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
gko::stop::ResidualNormReduction< ValueType > Class Template Reference

The ResidualNormReduction class is a stopping criterion which stops the iteration process when the relative residual norm is below a certain threshold. More...

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

Collaboration diagram for gko::stop::ResidualNormReduction< ValueType >:
[legend]

Classes

class  Factory
 
struct  parameters_type
 

Public Types

using Vector = matrix::Dense< ValueType >
 

Public Member Functions

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

Static Public Member Functions

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

Friends

class EnablePolymorphicObject< ResidualNormReduction< ValueType >, Criterion >
 

Detailed Description

template<typename ValueType = default_precision>
class gko::stop::ResidualNormReduction< ValueType >

The ResidualNormReduction class is a stopping criterion which stops the iteration process when the relative residual norm is below a certain threshold.

For better performance, the checks are run thanks to kernels on the executor where the algorithm is executed.

Note
To use this stopping criterion there are some dependencies. The constructor depends on initial_residual in order to compute the first relative residual norm. The check method depends on either the residual_norm or the residual being set. When any of those is not correctly provided, an exception ::gko::NotSupported() is thrown.

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