gko::solver::IterativeBase Class Reference

A LinOp implementing this interface stores a stopping criterion factory. More...

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

Inheritance diagram for gko::solver::IterativeBase:

Public Member Functions
std::shared_ptr< const stop::CriterionFactory >	get_stop_criterion_factory () const
	Gets the stopping criterion factory of the solver. More...
virtual void	set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory)
	Sets the stopping criterion of the solver. More...

Detailed Description

A LinOp implementing this interface stores a stopping criterion factory.

Member Function Documentation

get_stop_criterion_factory()

std::shared_ptr<const stop::CriterionFactory> gko::solver::IterativeBase::get_stop_criterion_factory ( ) const

inline

Gets the stopping criterion factory of the solver.

Returns

the stopping criterion factory

Referenced by gko::solver::EnableIterativeBase< Bicg< ValueType > >::operator=().

set_stop_criterion_factory()

virtual void gko::solver::IterativeBase::set_stop_criterion_factory ( std::shared_ptr< const stop::CriterionFactory >  new_stop_factory )

inlinevirtual

Sets the stopping criterion of the solver.

Parameters

other

the new stopping criterion factory

Reimplemented in gko::solver::EnableIterativeBase< DerivedType >, gko::solver::EnableIterativeBase< Bicgstab< ValueType > >, gko::solver::EnableIterativeBase< Multigrid >, gko::solver::EnableIterativeBase< Gmres< ValueType > >, gko::solver::EnableIterativeBase< CbGmres< ValueType > >, gko::solver::EnableIterativeBase< Ir< ValueType > >, gko::solver::EnableIterativeBase< Fcg< ValueType > >, gko::solver::EnableIterativeBase< Idr< ValueType > >, gko::solver::EnableIterativeBase< Cgs< ValueType > >, gko::solver::EnableIterativeBase< Gcr< ValueType > >, gko::solver::EnableIterativeBase< Cg< ValueType > >, and gko::solver::EnableIterativeBase< Bicg< ValueType > >.

Referenced by gko::solver::EnableIterativeBase< Bicg< ValueType > >::set_stop_criterion_factory().

---

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

• ginkgo/core/solver/solver_base.hpp