Ginkgo  Generated from pipelines/1330831941 branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Public Member Functions | Public Attributes | List of all members
gko::solver::enable_preconditioned_iterative_solver_factory_parameters< Parameters, Factory > Struct Template Reference
Inheritance diagram for gko::solver::enable_preconditioned_iterative_solver_factory_parameters< Parameters, Factory >:
[legend]
Collaboration diagram for gko::solver::enable_preconditioned_iterative_solver_factory_parameters< Parameters, Factory >:
[legend]

Public Member Functions

auto with_preconditioner (::gko::deferred_factory_parameter< preconditioner_type > factory) -> std::decay_t< decltype(*(this->self()))> &
 
template<typename... Args>
auto with_generated_preconditioner (Args &&... _value) -> std::decay_t< decltype(*(this->self()))> &
 
- Public Member Functions inherited from gko::solver::enable_iterative_solver_factory_parameters< Parameters, Factory >
template<typename... Args, typename = std::enable_if_t<::gko::xstd::conjunction< std::is_convertible<Args, ::gko::deferred_factory_parameter< criteria_type>>...>::value>>
auto with_criteria (Args &&... factories) -> std::decay_t< decltype(*(this->self()))> &
 
template<typename FactoryType , typename = std::enable_if_t<std::is_convertible< FactoryType, ::gko::deferred_factory_parameter< criteria_type>>::value>>
auto with_criteria (const std::vector< FactoryType > &factories) -> std::decay_t< decltype(*(this->self()))> &
 
- Public Member Functions inherited from gko::enable_parameters_type< Parameters, Factory >
Parameters & with_loggers (Args &&... _value)
 Provides the loggers to be added to the factory and its generated objects in a fluent interface.
 
std::unique_ptr< Factory > on (std::shared_ptr< const Executor > exec) const
 Creates a new factory on the specified executor. More...
 

Public Attributes

std::shared_ptr< const LinOpFactorypreconditioner {}
 The preconditioner to be used by the iterative solver. More...
 
std::shared_ptr< const LinOpgenerated_preconditioner { nullptr }
 Already generated preconditioner. More...
 
- Public Attributes inherited from gko::solver::enable_iterative_solver_factory_parameters< Parameters, Factory >
std::vector< std::shared_ptr< const stop::CriterionFactory > > criteria {}
 Stopping criteria to be used by the solver.
 

Additional Inherited Members

- Public Types inherited from gko::enable_parameters_type< Parameters, Factory >
using factory = Factory
 

Member Data Documentation

◆ generated_preconditioner

template<typename Parameters, typename Factory>
std::shared_ptr<const LinOp> gko::solver::enable_preconditioned_iterative_solver_factory_parameters< Parameters, Factory >::generated_preconditioner { nullptr }

Already generated preconditioner.

If one is provided, the factory preconditioner will be ignored.

◆ preconditioner

template<typename Parameters, typename Factory>
std::shared_ptr<const LinOpFactory> gko::solver::enable_preconditioned_iterative_solver_factory_parameters< Parameters, Factory >::preconditioner {}

The preconditioner to be used by the iterative solver.

By default, no preconditioner is used.


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