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
polymorphic_object.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_DISTRIBUTED_POLYMORPHIC_OBJECT_HPP_
34#define GKO_PUBLIC_CORE_DISTRIBUTED_POLYMORPHIC_OBJECT_HPP_
35
36
37#include <memory>
38#include <type_traits>
39
40
41#include <ginkgo/config.hpp>
42
43
44#if GINKGO_BUILD_MPI
45
46
47#include <ginkgo/core/base/polymorphic_object.hpp>
48#include <ginkgo/core/distributed/base.hpp>
49
50
51namespace gko {
52namespace experimental {
53
54
80template <typename ConcreteObject, typename PolymorphicBase = PolymorphicObject>
82 : public EnableAbstractPolymorphicObject<ConcreteObject, PolymorphicBase> {
83protected:
85 ConcreteObject, PolymorphicBase>::EnableAbstractPolymorphicObject;
86
87 std::unique_ptr<PolymorphicObject> create_default_impl(
88 std::shared_ptr<const Executor> exec) const override
89 {
90 return std::unique_ptr<ConcreteObject>{
91 new ConcreteObject(exec, self()->get_communicator())};
92 }
93
94 PolymorphicObject* copy_from_impl(const PolymorphicObject* other) override
95 {
96 as<ConvertibleTo<ConcreteObject>>(other)->convert_to(self());
97 return this;
98 }
99
100 PolymorphicObject* copy_from_impl(
101 std::unique_ptr<PolymorphicObject> other) override
102 {
103 as<ConvertibleTo<ConcreteObject>>(other.get())->move_to(self());
104 return this;
105 }
106
107 PolymorphicObject* move_from_impl(PolymorphicObject* other) override
108 {
109 as<ConvertibleTo<ConcreteObject>>(other)->move_to(self());
110 return this;
111 }
112
113 PolymorphicObject* move_from_impl(
114 std::unique_ptr<PolymorphicObject> other) override
115 {
116 as<ConvertibleTo<ConcreteObject>>(other.get())->move_to(self());
117 return this;
118 }
119
120 PolymorphicObject* clear_impl() override
121 {
122 *self() =
123 ConcreteObject{self()->get_executor(), self()->get_communicator()};
124 return this;
125 }
126
127private:
128 GKO_ENABLE_SELF(ConcreteObject);
129};
130
131
132} // namespace experimental
133} // namespace gko
134
135
136#endif // GINKGO_BUILD_MPI
137#endif // GKO_PUBLIC_CORE_DISTRIBUTED_POLYMORPHIC_OBJECT_HPP_
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:374
A PolymorphicObject is the abstract base for all "heavy" objects in Ginkgo that behave polymorphicall...
Definition polymorphic_object.hpp:72
This mixin does the same as EnablePolymorphicObject, but for concrete types that are derived from dis...
Definition polymorphic_object.hpp:82
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803