Ginkgo  Generated from pipelines/375350765 branch based on develop. Ginkgo version 1.5.0
A numerical linear algebra library targeting many-core architectures
Friends | List of all members
gko::stop::ResidualNormBase< ValueType > Class Template Reference

The ResidualNormBase class provides a framework for stopping criteria related to the residual norm. More...

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

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

Friends

class EnablePolymorphicObject< ResidualNormBase< ValueType >, Criterion >
 

Additional Inherited Members

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

Detailed Description

template<typename ValueType>
class gko::stop::ResidualNormBase< ValueType >

The ResidualNormBase class provides a framework for stopping criteria related to the residual norm.

These criteria differ in the way they initialize starting_tau_, so in the value they compare the residual norm against. The provided check_impl uses the actual residual to check for convergence.


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