Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
time.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_STOP_TIME_HPP_
34#define GKO_PUBLIC_CORE_STOP_TIME_HPP_
35
36
37#include <chrono>
38
39
40#include <ginkgo/core/stop/criterion.hpp>
41
42
43namespace gko {
44namespace stop {
45
52class Time : public EnablePolymorphicObject<Time, Criterion> {
54
55public:
56 using clock = std::chrono::steady_clock;
57
59 {
63 std::chrono::nanoseconds GKO_FACTORY_PARAMETER_SCALAR(time_limit,
64 10000000000LL);
65 };
66 GKO_ENABLE_CRITERION_FACTORY(Time, parameters, Factory);
68
69protected:
70 bool check_impl(uint8 stoppingId, bool setFinalized,
72 const Updater&) override;
73
74 explicit Time(std::shared_ptr<const gko::Executor> exec)
76 time_limit_{},
77 start_{}
78 {}
79
80 explicit Time(const Factory* factory, const CriterionArgs args)
82 parameters_{factory->get_parameters()},
83 time_limit_{std::chrono::duration<double>(
84 factory->get_parameters().time_limit)},
85 start_{clock::now()}
86 {}
87
88private:
94 std::chrono::duration<double> time_limit_;
95 clock::time_point start_;
96};
97
98
99} // namespace stop
100} // namespace gko
101
102
103#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:691
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:187
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:64
Definition time.hpp:66
The Time class is a stopping criterion which stops the iteration process after a certain amount of ti...
Definition time.hpp:52
#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:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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:422
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:149
This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate...
Definition criterion.hpp:233