A module dedicated to the implementation and usage of the Stopping Criteria in Ginkgo. More...

Namespaces
namespace	gko::stop
	The Stopping criterion namespace. Stopping criteria.

Classes
class	gko::stop::Combined

class	gko::stop::Iteration

class	gko::stop::ResidualNormBase< ValueType >

class	gko::stop::ResidualNorm< ValueType >

class	gko::stop::ImplicitResidualNorm< ValueType >

class	gko::stop::ResidualNormReduction< ValueType >

class	gko::stop::RelativeResidualNorm< ValueType >

class	gko::stop::AbsoluteResidualNorm< ValueType >

class	gko::stopping_status

class	gko::stop::Time

Enumerations
enum class	gko::stop::mode { absolute , initial_resnorm , rhs_norm }

Functions
template<typename FactoryContainer >
std::shared_ptr< const CriterionFactory >	gko::stop::combine (FactoryContainer &&factories)

Detailed Description

A module dedicated to the implementation and usage of the Stopping Criteria in Ginkgo.

Enumeration Type Documentation

strong

The mode for the residual norm criterion.

absolute: Check for tolerance against residual norm. \( || r || \leq \tau \)
initial_resnorm: Check for tolerance relative to the initial residual norm. \( || r || \leq \tau \times || r_0|| \)
rhs_norm: Check for tolerance relative to the rhs norm. \( || r || \leq \tau \times || b || \)

template<typename FactoryContainer >

std::shared_ptr< const CriterionFactory > gko::stop::combine ( FactoryContainer && factories )

Combines multiple criterion factories into a single combined criterion factory.

This function treats a singleton container as a special case and avoids creating an additional object and just returns the input factory.

Template Parameters

FactoryContainer a random access container type

Parameters

factories a list of factories to combined

Returns: a combined criterion factory if the input contains multiple factories or the input factory if the input contains only one factory