![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
The ResidualNormReduction 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 initial residual, i.e. More...
#include <ginkgo/core/stop/residual_norm.hpp>
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_type & | get_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()) |
The ResidualNormReduction 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 initial residual, i.e.
when norm(residual) / norm(initial_residual) < threshold. For better performance, the checks are run thanks to kernels on the executor where the algorithm is executed.