parameters_type Struct Reference

parameters_type Struct Reference#

Reference API: ByInteraction::parameters_type Struct Reference
Reference API
ByInteraction::parameters_type Struct Reference
Inheritance diagram for ByInteraction::parameters_type:
[legend]

Public Member Functions

template<typename... Args>
auto with_stop_iteration_process (Args &&... _value) -> std::decay_t< decltype(*(this->self()))> &
 
- Public Member Functions inherited from gko::enable_parameters_type< parameters_type, Factory >
parameters_type & with_loggers (Args &&... _value)
 
std::unique_ptr< Factory > on (std::shared_ptr< const Executor > exec) const
 

Public Attributes

std::add_pointer< volatilebool >::type stop_iteration_process { nullptr }
 

Additional Inherited Members

- Public Types inherited from gko::enable_parameters_type< parameters_type, Factory >
using factory = Factory
 
- Protected Member Functions inherited from gko::enable_parameters_type< parameters_type, Factory >
parameters_type * self () noexcept
 
const parameters_type * self () const noexcept
 
- Protected Attributes inherited from gko::enable_parameters_type< parameters_type, Factory >
std::vector< std::shared_ptr< const log::Logger > > loggers
 
std::unordered_map< std::string, std::function< void(std::shared_ptr< const Executor > exec, parameters_type &)> > deferred_factories
 

Member Data Documentation

◆ stop_iteration_process

std::add_pointer<volatilebool>::type ByInteraction::parameters_type::stop_iteration_process { nullptr }

Boolean set by the user to stop the iteration process


The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/ginkgo-test/checkouts/latest/build/doc/doxygen/examples/custom-stopping-criterion.cpp