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

The ResidualNorm 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::ResidualNorm< ValueType >:
[legend]

Public Types

using ComplexVector = matrix::Dense< to_complex< ValueType > >
 
using NormVector = matrix::Dense< remove_complex< ValueType > >
 
using Vector = matrix::Dense< ValueType >
 

Friends

class EnablePolymorphicObject< ResidualNorm< ValueType >, Criterion >
 

Additional Inherited Members

- 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 ()
 

Detailed Description

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

The ResidualNorm 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 documentation for this class was generated from the following file: