gko::stop Namespace Reference

The Stopping criterion namespace. Stopping criteria. More...

Classes
class	AbsoluteResidualNorm
class	Combined
class	Criterion
struct	CriterionArgs
class	ImplicitResidualNorm
class	Iteration
class	RelativeResidualNorm
class	ResidualNorm
class	ResidualNormBase
class	ResidualNormReduction
class	Time

Typedefs
using	CriterionFactory = AbstractFactory< Criterion, CriterionArgs >
template<typename ConcreteFactory , typename ConcreteCriterion , typename ParametersType , typename PolymorphicBase = CriterionFactory>
using	EnableDefaultCriterionFactory = EnableDefaultFactory< ConcreteFactory, ConcreteCriterion, ParametersType, PolymorphicBase >

Enumerations
enum class	mode { absolute , initial_resnorm , rhs_norm }

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

Detailed Description

The Stopping criterion namespace. Stopping criteria.

The Stopping criterion namespace.

Typedef Documentation

CriterionFactory

using gko::stop::CriterionFactory = typedef AbstractFactory<Criterion, CriterionArgs>

Declares an Abstract Factory specialized for Criterions

EnableDefaultCriterionFactory

template<typename ConcreteFactory , typename ConcreteCriterion , typename ParametersType , typename PolymorphicBase = CriterionFactory>

using gko::stop::EnableDefaultCriterionFactory = typedef EnableDefaultFactory<ConcreteFactory, ConcreteCriterion, ParametersType, PolymorphicBase>

This is an alias for the EnableDefaultFactory mixin, which correctly sets the template parameters to enable a subclass of CriterionFactory.

Template Parameters

ConcreteFactory	the concrete factory which is being implemented [CRTP parameter]
ConcreteCriterion	the concrete Criterion type which this factory produces, needs to have a constructor which takes a const ConcreteFactory *, and a const CriterionArgs * as parameters.
ParametersType	a subclass of enable_parameters_type template which defines all of the parameters of the factory
PolymorphicBase	parent of ConcreteFactory in the polymorphic hierarchy, has to be a subclass of CriterionFactory