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

The RelativeResidualNorm class is a stopping criterion which stops the iteration process when the residual norm is below a certain threshold relative to the norm of the right-hand side, i.e. More...

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

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

Classes

class  Factory
 
struct  parameters_type
 

Public Types

using ComplexVector = matrix::Dense< to_complex< ValueType > >
 
using NormVector = matrix::Dense< remove_complex< ValueType > >
 
using Vector = matrix::Dense< ValueType >
 
- Public Types inherited from gko::stop::ResidualNorm< ValueType >
using ComplexVector = matrix::Dense< to_complex< ValueType > >
 
using NormVector = matrix::Dense< remove_complex< ValueType > >
 
using Vector = matrix::Dense< ValueType >
 

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

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

The RelativeResidualNorm class is a stopping criterion which stops the iteration process when the residual norm is below a certain threshold relative to the norm of the right-hand side, i.e.

when norm(residual) / norm(right_hand_side) < 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 b in order to compute the norm of the right-hand side. If this is not correctly provided, an exception ::gko::NotSupported() is thrown.

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