Ginkgo: gko::stop::ImplicitResidualNorm< ValueType > Class Template Reference

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
gko::stop::ImplicitResidualNorm< ValueType > Class Template Reference
Stopping criteria

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
struct | parameters_type
class | Factory

## 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_type & | get_parameters () const

## 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 < threshold * norm(right_hand_side)
2. the initial residual, implicit_resnorm threshold * norm(initial_residual) .
3. one, implicit_resnorm 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:

- ginkgo/core/stop/residual_norm.hpp