Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::stop::ImplicitResidualNorm< ValueType > Class Template Reference

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

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

Inheritance diagram for gko::stop::ImplicitResidualNorm< ValueType >:
[legend]
Collaboration diagram for gko::stop::ImplicitResidualNorm< 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 Member Functions

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

Static Public Member Functions

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

Detailed Description

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

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

  1. the norm of the right-hand side, implicit_resnorm $\leq$ < threshold * norm(right_hand_side)
  2. the initial residual, implicit_resnorm $\leq$ threshold * norm(initial_residual) .
  3. one, implicit_resnorm $\leq$ threshold.
Note
To use this stopping criterion there are some dependencies. The constructor depends on either b or the initial_residual in order to compute their norms. If this is not correctly provided, an exception ::gko::NotSupported() is thrown.

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