Ginkgo Generated from branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
time.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_STOP_TIME_HPP_
6#define GKO_PUBLIC_CORE_STOP_TIME_HPP_
7
8
9#include <chrono>
10
11
12#include <ginkgo/core/stop/criterion.hpp>
13
14
15namespace gko {
16namespace stop {
17
24class Time : public EnablePolymorphicObject<Time, Criterion> {
26
27public:
28 using clock = std::chrono::steady_clock;
29
31 {
35 std::chrono::nanoseconds GKO_FACTORY_PARAMETER_SCALAR(time_limit,
36 10000000000LL);
37 };
38 GKO_ENABLE_CRITERION_FACTORY(Time, parameters, Factory);
40
41protected:
42 bool check_impl(uint8 stoppingId, bool setFinalized,
43 array<stopping_status>* stop_status, bool* one_changed,
44 const Updater&) override;
45
46 explicit Time(std::shared_ptr<const gko::Executor> exec)
47 : EnablePolymorphicObject<Time, Criterion>(std::move(exec)),
48 time_limit_{},
49 start_{}
50 {}
51
52 explicit Time(const Factory* factory, const CriterionArgs args)
53 : EnablePolymorphicObject<Time, Criterion>(factory->get_executor()),
54 parameters_{factory->get_parameters()},
55 time_limit_{std::chrono::duration<double>(
56 factory->get_parameters().time_limit)},
57 start_{clock::now()}
58 {}
59
60private:
66 std::chrono::duration<double> time_limit_;
67 clock::time_point start_;
68};
69
70
71} // namespace stop
72} // namespace gko
73
74
75#endif // GKO_PUBLIC_CORE_STOP_TIME_HPP_
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:36
Definition time.hpp:38
The Time class is a stopping criterion which stops the iteration process after a certain amount of ti...
Definition time.hpp:24
#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 Ginkgo namespace.
Definition abstract_factory.hpp:20
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:115
This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate...
Definition criterion.hpp:205