operation.hpp 9.92 KB
Newer Older
Paul's avatar
Paul committed
1
2
#ifndef MIGRAPH_GUARD_MIGRAPHLIB_OPERAND_HPP
#define MIGRAPH_GUARD_MIGRAPHLIB_OPERAND_HPP
Paul's avatar
Paul committed
3

Paul's avatar
Paul committed
4
#include <string>
Paul's avatar
Paul committed
5
#include <functional>
Paul's avatar
Paul committed
6
7
8
#include <memory>
#include <type_traits>
#include <utility>
Paul's avatar
Paul committed
9
10
11
#include <migraph/shape.hpp>
#include <migraph/argument.hpp>
#include <migraph/context.hpp>
Paul's avatar
Paul committed
12
#include <migraph/auto_any_cast.hpp>
Paul's avatar
Paul committed
13

Paul's avatar
Paul committed
14
namespace migraph {
Paul's avatar
Paul committed
15

Paul's avatar
Paul committed
16
17
#ifdef DOXYGEN

Paul's avatar
Paul committed
18
/// The operation interface represents an action an instruction will perform. All
Paul's avatar
Paul committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/// operation classes must be CopyConstructible.
struct operation
{
    /// A unique name identifying the operation
    std::string name() const;
    /// This is used to compute the resulting shape from an operation. If an
    /// operation cannot be run with input shapes, then it should throw an
    /// exception.
    shape compute_shape(std::vector<shape> input) const;
    /**
     * @brief This performs the operation's computation
     *
     * @param ctx This is the context created by the `target` during compilation. Implementations
     * can use the target's `context` class rather than the `context` interface class.
     * @param output This is the output shape. It is equivalent to running `compute_shape` with each
     * `shape` of the `argument`.
     * @param input This is the `argument` result from the previous instuction's computation.
     * @return Return an `argument` of the result computation. The `shape` of `argument` should be
     * the same the `output` shape.
     */
    argument compute(context& ctx, shape output, std::vector<argument> input) const;
    /// An optional stream operator to print the operation. When this is not
    /// implemented, it will just print the operation's name.
    friend std::ostream& operator<<(std::ostream& os, const operation& op);
};

#else

Paul's avatar
Paul committed
47
48
49
50
51
52
53
54
55
56
namespace operation_stream {

template <class T>
auto operator<<(std::ostream& os, const T& x) -> decltype(os << x.name())
{
    return os << x.name();
}

} // namespace operation_stream

Paul's avatar
Paul committed
57
58
59
60
61
62
template <class T>
argument compute_op(const T& x, context& ctx, shape output_shape, std::vector<argument> input)
{
    return x.compute(auto_any_cast(ctx), output_shape, input);
}

Paul's avatar
Paul committed
63
/*
Paul's avatar
Paul committed
64
65
 * Type-erased interface for:
 *
Paul's avatar
Paul committed
66
 * struct operation
Paul's avatar
Paul committed
67
 * {
Paul's avatar
Paul committed
68
69
 *      std::string name() const;
 *      shape compute_shape(std::vector<shape> input) const;
Paul's avatar
Paul committed
70
 *      argument compute(context& ctx,shape output,std::vector<argument> input) const;
Paul's avatar
Paul committed
71
 *     friend std::ostream & operator<<(std::ostream & os,const operation & op) ;
Paul's avatar
Paul committed
72
73
74
 * };
 *
 */
Paul's avatar
Paul committed
75

Paul's avatar
Paul committed
76
struct operation
Paul's avatar
Paul committed
77
{
Paul's avatar
Paul committed
78
    // Constructors
Paul's avatar
Paul committed
79
    operation() = default;
Paul's avatar
Paul committed
80

Paul's avatar
Paul committed
81
    template <typename PrivateDetailTypeErasedT>
Paul's avatar
Paul committed
82
    operation(PrivateDetailTypeErasedT value)
Paul's avatar
Paul committed
83
84
85
86
        : private_detail_te_handle_mem_var(
              std::make_shared<private_detail_te_handle_type<
                  typename std::remove_reference<PrivateDetailTypeErasedT>::type>>(
                  std::forward<PrivateDetailTypeErasedT>(value)))
Paul's avatar
Paul committed
87
88
89
90
    {
    }

    // Assignment
Paul's avatar
Paul committed
91
    template <typename PrivateDetailTypeErasedT>
Paul's avatar
Paul committed
92
    operation& operator=(PrivateDetailTypeErasedT value)
Paul's avatar
Paul committed
93
    {
Paul's avatar
Paul committed
94
95
96
97
98
        if(private_detail_te_handle_mem_var.unique())
            *private_detail_te_handle_mem_var = std::forward<PrivateDetailTypeErasedT>(value);
        else if(!private_detail_te_handle_mem_var)
            private_detail_te_handle_mem_var = std::make_shared<PrivateDetailTypeErasedT>(
                std::forward<PrivateDetailTypeErasedT>(value));
Paul's avatar
Paul committed
99
100
101
        return *this;
    }

Paul's avatar
Paul committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
    // Cast
    template <typename PrivateDetailTypeErasedT>
    PrivateDetailTypeErasedT* any_cast()
    {
        return private_detail_te_get_handle().type() == typeid(PrivateDetailTypeErasedT)
                   ? std::addressof(static_cast<private_detail_te_handle_type<
                                        typename std::remove_cv<PrivateDetailTypeErasedT>::type>&>(
                                        private_detail_te_get_handle())
                                        .private_detail_te_value)
                   : nullptr;
    }

    template <typename PrivateDetailTypeErasedT>
    const typename std::remove_cv<PrivateDetailTypeErasedT>::type* any_cast() const
    {
        return private_detail_te_get_handle().type() == typeid(PrivateDetailTypeErasedT)
                   ? std::addressof(static_cast<const private_detail_te_handle_type<
                                        typename std::remove_cv<PrivateDetailTypeErasedT>::type>&>(
                                        private_detail_te_get_handle())
                                        .private_detail_te_value)
                   : nullptr;
    }

Paul's avatar
Paul committed
125
126
127
128
129
130
131
132
    const std::type_info& type_id() const
    {
        if(private_detail_te_handle_empty())
            return typeid(std::nullptr_t);
        else
            return private_detail_te_get_handle().type();
    }

Paul's avatar
Paul committed
133
134
    std::string name() const
    {
Paul's avatar
Paul committed
135
136
        assert((*this).private_detail_te_handle_mem_var);
        return (*this).private_detail_te_get_handle().name();
Paul's avatar
Paul committed
137
138
139
140
    }

    shape compute_shape(std::vector<shape> input) const
    {
Paul's avatar
Paul committed
141
142
        assert((*this).private_detail_te_handle_mem_var);
        return (*this).private_detail_te_get_handle().compute_shape(std::move(input));
Paul's avatar
Paul committed
143
144
    }

Paul's avatar
Paul committed
145
    argument compute(context& ctx, shape output, std::vector<argument> input) const
Paul's avatar
Paul committed
146
    {
Paul's avatar
Paul committed
147
        assert((*this).private_detail_te_handle_mem_var);
Paul's avatar
Paul committed
148
149
        return (*this).private_detail_te_get_handle().compute(
            ctx, std::move(output), std::move(input));
Paul's avatar
Paul committed
150
151
152
153
154
155
    }

    friend std::ostream& operator<<(std::ostream& os, const operation& op)
    {
        assert(op.private_detail_te_handle_mem_var);
        return op.private_detail_te_get_handle().operator_shift_left(os);
Paul's avatar
Paul committed
156
157
158
    }

    private:
Paul's avatar
Paul committed
159
    struct private_detail_te_handle_base_type
Paul's avatar
Paul committed
160
    {
Paul's avatar
Paul committed
161
162
        virtual ~private_detail_te_handle_base_type() {}
        virtual std::shared_ptr<private_detail_te_handle_base_type> clone() const = 0;
Paul's avatar
Paul committed
163
        virtual const std::type_info& type() const                                = 0;
Paul's avatar
Paul committed
164

Paul's avatar
Paul committed
165
166
167
168
        virtual std::string name() const                                                        = 0;
        virtual shape compute_shape(std::vector<shape> input) const                             = 0;
        virtual argument compute(context& ctx, shape output, std::vector<argument> input) const = 0;
        virtual std::ostream& operator_shift_left(std::ostream& os) const                       = 0;
Paul's avatar
Paul committed
169
170
    };

Paul's avatar
Paul committed
171
172
    template <typename PrivateDetailTypeErasedT>
    struct private_detail_te_handle_type : private_detail_te_handle_base_type
Paul's avatar
Paul committed
173
    {
Paul's avatar
Paul committed
174
175
176
177
178
179
        template <typename PrivateDetailTypeErasedU = PrivateDetailTypeErasedT>
        private_detail_te_handle_type(
            PrivateDetailTypeErasedT value,
            typename std::enable_if<std::is_reference<PrivateDetailTypeErasedU>::value>::type* =
                nullptr)
            : private_detail_te_value(value)
Paul's avatar
Paul committed
180
181
182
        {
        }

Paul's avatar
Paul committed
183
184
185
186
187
188
        template <typename PrivateDetailTypeErasedU = PrivateDetailTypeErasedT>
        private_detail_te_handle_type(
            PrivateDetailTypeErasedT value,
            typename std::enable_if<!std::is_reference<PrivateDetailTypeErasedU>::value,
                                    int>::type* = nullptr) noexcept
            : private_detail_te_value(std::move(value))
Paul's avatar
Paul committed
189
190
191
        {
        }

Paul's avatar
Paul committed
192
        std::shared_ptr<private_detail_te_handle_base_type> clone() const override
Paul's avatar
Paul committed
193
        {
Paul's avatar
Paul committed
194
            return std::make_shared<private_detail_te_handle_type>(private_detail_te_value);
Paul's avatar
Paul committed
195
196
        }

Paul's avatar
Paul committed
197
        const std::type_info& type() const override { return typeid(private_detail_te_value); }
Paul's avatar
Paul committed
198

Paul's avatar
Paul committed
199
        std::string name() const override { return private_detail_te_value.name(); }
Paul's avatar
Paul committed
200

Paul's avatar
Paul committed
201
        shape compute_shape(std::vector<shape> input) const override
Paul's avatar
Paul committed
202
        {
Paul's avatar
Paul committed
203

Paul's avatar
Paul committed
204
            return private_detail_te_value.compute_shape(std::move(input));
Paul's avatar
Paul committed
205
206
        }

Paul's avatar
Paul committed
207
        argument compute(context& ctx, shape output, std::vector<argument> input) const override
Paul's avatar
Paul committed
208
        {
Paul's avatar
Paul committed
209

Paul's avatar
Paul committed
210
            return compute_op(private_detail_te_value, ctx, std::move(output), std::move(input));
Paul's avatar
Paul committed
211
212
        }

Paul's avatar
Paul committed
213
214
        std::ostream& operator_shift_left(std::ostream& os) const override
        {
Paul's avatar
Paul committed
215
            using migraph::operation_stream::operator<<;
Paul's avatar
Paul committed
216
217
218
            return os << private_detail_te_value;
        }

Paul's avatar
Paul committed
219
        PrivateDetailTypeErasedT private_detail_te_value;
Paul's avatar
Paul committed
220
221
    };

Paul's avatar
Paul committed
222
223
224
    template <typename PrivateDetailTypeErasedT>
    struct private_detail_te_handle_type<std::reference_wrapper<PrivateDetailTypeErasedT>>
        : private_detail_te_handle_type<PrivateDetailTypeErasedT&>
Paul's avatar
Paul committed
225
    {
Paul's avatar
Paul committed
226
227
        private_detail_te_handle_type(std::reference_wrapper<PrivateDetailTypeErasedT> ref)
            : private_detail_te_handle_type<PrivateDetailTypeErasedT&>(ref.get())
Paul's avatar
Paul committed
228
229
230
231
        {
        }
    };

Paul's avatar
Paul committed
232
233
234
235
236
    bool private_detail_te_handle_empty() const
    {
        return private_detail_te_handle_mem_var == nullptr;
    }

Paul's avatar
Paul committed
237
238
    const private_detail_te_handle_base_type& private_detail_te_get_handle() const
    {
Paul's avatar
Paul committed
239
        assert(private_detail_te_handle_mem_var != nullptr);
Paul's avatar
Paul committed
240
241
        return *private_detail_te_handle_mem_var;
    }
Paul's avatar
Paul committed
242

Paul's avatar
Paul committed
243
    private_detail_te_handle_base_type& private_detail_te_get_handle()
Paul's avatar
Paul committed
244
    {
Paul's avatar
Paul committed
245
        assert(private_detail_te_handle_mem_var != nullptr);
Paul's avatar
Paul committed
246
247
248
        if(!private_detail_te_handle_mem_var.unique())
            private_detail_te_handle_mem_var = private_detail_te_handle_mem_var->clone();
        return *private_detail_te_handle_mem_var;
Paul's avatar
Paul committed
249
250
    }

Paul's avatar
Paul committed
251
    std::shared_ptr<private_detail_te_handle_base_type> private_detail_te_handle_mem_var;
Paul's avatar
Paul committed
252
253
};

Paul's avatar
Paul committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
template <typename ValueType>
inline const ValueType* any_cast(const operation* x)
{
    return x->any_cast<ValueType>();
}

template <typename ValueType>
inline ValueType* any_cast(operation* x)
{
    return x->any_cast<ValueType>();
}

template <typename ValueType>
inline ValueType& any_cast(operation& x)
{
Paul's avatar
Paul committed
269
    auto* y = x.any_cast<typename std::remove_reference<ValueType>::type>();
Paul's avatar
Paul committed
270
271
272
273
274
275
276
277
    if(y == nullptr)
        throw std::bad_cast();
    return *y;
}

template <typename ValueType>
inline const ValueType& any_cast(const operation& x)
{
Paul's avatar
Paul committed
278
    const auto* y = x.any_cast<typename std::remove_reference<ValueType>::type>();
Paul's avatar
Paul committed
279
280
281
282
283
    if(y == nullptr)
        throw std::bad_cast();
    return *y;
}

Paul's avatar
Paul committed
284
285
#endif

Paul's avatar
Paul committed
286
} // namespace migraph
Paul's avatar
Paul committed
287
288

#endif