Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
 
Loading...
Searching...
No Matches
iteration.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 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
24class Iteration : public EnablePolymorphicObject<Iteration, Criterion> {
25 friend class EnablePolymorphicObject<Iteration, Criterion>;
26
27public:
35 GKO_ENABLE_CRITERION_FACTORY(Iteration, parameters, Factory);
37
38protected:
39 bool check_impl(uint8 stoppingId, bool setFinalized,
40 array<stopping_status>* stop_status, bool* one_changed,
41 const Updater& updater) override;
42
43 explicit Iteration(std::shared_ptr<const gko::Executor> exec)
44 : EnablePolymorphicObject<Iteration, Criterion>(std::move(exec))
45 {}
46
47 explicit Iteration(const Factory* factory, const CriterionArgs& args)
49 factory->get_executor()),
50 parameters_{factory->get_parameters()}
51 {}
52};
53
54
55} // namespace stop
56} // namespace gko
57
58
59#endif // GKO_PUBLIC_CORE_STOP_ITERATION_HPP_
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:36
Definition iteration.hpp:35
#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
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#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
The Stopping criterion namespace.
Definition logger.hpp:52
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:118
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
STL namespace.
This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate...
Definition criterion.hpp:205
size_type max_iters
Maximum number of iterations.
Definition iteration.hpp:33