gko::solver::EnableIterativeBase< DerivedType > Class Template Reference

#include <ginkgo/core/solver/solver_base.hpp>

Inheritance diagram for gko::solver::EnableIterativeBase< DerivedType >:

Public Member Functions
EnableIterativeBase &	operator= (const EnableIterativeBase &other)
EnableIterativeBase &	operator= (EnableIterativeBase &&other)
	EnableIterativeBase (std::shared_ptr< const stop::CriterionFactory > stop_factory)
	EnableIterativeBase (const EnableIterativeBase &other)
	EnableIterativeBase (EnableIterativeBase &&other)
void	set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override
Public Member Functions inherited from gko::solver::IterativeBase
std::shared_ptr< const stop::CriterionFactory >	get_stop_criterion_factory () const

Detailed Description

template<typename DerivedType>
class gko::solver::EnableIterativeBase< DerivedType >

A LinOp deriving from this CRTP class stores a stopping criterion factory and allows applying with a guess.

Template Parameters

DerivedType

the CRTP type that derives from this

Constructor & Destructor Documentation

EnableIterativeBase() [1/2]

template<typename DerivedType >

gko::solver::EnableIterativeBase< DerivedType >::EnableIterativeBase ( const EnableIterativeBase< DerivedType > &  other )

inline

Creates a shallow copy of the provided stopping criterion.

EnableIterativeBase() [2/2]

template<typename DerivedType >

gko::solver::EnableIterativeBase< DerivedType >::EnableIterativeBase ( EnableIterativeBase< DerivedType > &&  other )

inline

Moves the provided stopping criterion. The moved-from object has a nullptr stopping criterion.

Member Function Documentation

operator=() [1/2]

template<typename DerivedType >

EnableIterativeBase & gko::solver::EnableIterativeBase< DerivedType >::operator= ( const EnableIterativeBase< DerivedType > &  other )

inline

Creates a shallow copy of the provided stopping criterion, clones it onto this executor if executors don't match.

References gko::solver::IterativeBase::get_stop_criterion_factory(), and gko::solver::EnableIterativeBase< DerivedType >::set_stop_criterion_factory().

operator=() [2/2]

template<typename DerivedType >

EnableIterativeBase & gko::solver::EnableIterativeBase< DerivedType >::operator= ( EnableIterativeBase< DerivedType > &&  other )

inline

Moves the provided stopping criterion, clones it onto this executor if executors don't match. The moved-from object has a nullptr stopping criterion.

References gko::solver::EnableIterativeBase< DerivedType >::set_stop_criterion_factory().

set_stop_criterion_factory()

template<typename DerivedType >

void gko::solver::EnableIterativeBase< DerivedType >::set_stop_criterion_factory ( std::shared_ptr< const stop::CriterionFactory >  new_stop_factory )

inlineoverridevirtual

Sets the stopping criterion of the solver.

Parameters

other

the new stopping criterion factory

Reimplemented from gko::solver::IterativeBase.

References gko::clone(), and gko::solver::IterativeBase::set_stop_criterion_factory().

Referenced by gko::solver::EnableIterativeBase< DerivedType >::operator=(), and gko::solver::EnableIterativeBase< DerivedType >::operator=().

---

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

• ginkgo/core/solver/solver_base.hpp