Ginkgo: ginkgo/core/stop/iteration.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
iteration.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_STOP_ITERATION_HPP_
6#define GKO_PUBLIC_CORE_STOP_ITERATION_HPP_
7
8
9#include <ginkgo/core/stop/criterion.hpp>
10
11
12namespace gko {
13namespace stop {
14
24 class Iteration : public EnablePolymorphicObject<Iteration, Criterion> {
25 friend class EnablePolymorphicObject<Iteration, Criterion>;
26
27public:
28 GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
29 {
33 size_type max_iters{0};
34
35 parameters_type& with_max_iters(size_type value)
36 {
37 this->max_iters = value;
38 return *this;
39 }
40 };
41 GKO_ENABLE_CRITERION_FACTORY(Iteration, parameters, Factory);
42 GKO_ENABLE_BUILD_METHOD(Factory);
43
44protected:
45 bool check_impl(uint8 stoppingId, bool setFinalized,
46 array<stopping_status>* stop_status, bool* one_changed,
47 const Updater& updater) override;
48
49 explicit Iteration(std::shared_ptr<const gko::Executor> exec)
50 : EnablePolymorphicObject<Iteration, Criterion>(std::move(exec))
51 {}
52
53 explicit Iteration(const Factory* factory, const CriterionArgs& args)
54 : EnablePolymorphicObject<Iteration, Criterion>(
55 factory->get_executor()),
56 parameters_{factory->get_parameters()}
57 {}
58};
59
60
61} // namespace stop
62} // namespace gko
63
64
65#endif // GKO_PUBLIC_CORE_STOP_ITERATION_HPP_
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::array
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
gko::stop::Criterion
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:36
gko::stop::Iteration::Factory
Definition iteration.hpp:41
GKO_CREATE_FACTORY_PARAMETERS
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:280
GKO_ENABLE_BUILD_METHOD
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition abstract_factory.hpp:394
gko::stop
The Stopping criterion namespace.
Definition logger.hpp:50
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::uint8
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:119
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
std
STL namespace.
gko::stop::CriterionArgs
This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate...
Definition criterion.hpp:205
gko::stop::Iteration::parameters_type
Definition iteration.hpp:29
gko::stop::Iteration::parameters_type::max_iters
size_type max_iters
Maximum number of iterations.
Definition iteration.hpp:33