pass.hpp 789 Bytes
Newer Older
Paul's avatar
Paul committed
1
2
#ifndef MIGRAPHX_GUARD_PASS_HPP
#define MIGRAPHX_GUARD_PASS_HPP
Paul's avatar
Paul committed
3

Paul's avatar
Paul committed
4
#include <cassert>
Paul's avatar
Paul committed
5
6
7
8
9
#include <string>
#include <functional>
#include <memory>
#include <type_traits>
#include <utility>
Paul's avatar
Paul committed
10
#include <migraphx/config.hpp>
Paul's avatar
Paul committed
11

Paul's avatar
Paul committed
12
namespace migraphx {
Paul's avatar
Paul committed
13
inline namespace MIGRAPHX_INLINE_NS {
Paul's avatar
Paul committed
14
15
16

struct program;

Paul's avatar
Paul committed
17
18
#ifdef DOXYGEN

Paul's avatar
Paul committed
19
20
/// An interface for applying a transformation to the instructions in a
/// `program`
Paul's avatar
Paul committed
21
22
23
24
25
struct pass
{
    /// A unique name used to identify the pass
    std::string name() const;
    /// Run the pass on the program
Paul's avatar
Paul committed
26
    void apply(program& p) const;
Paul's avatar
Paul committed
27
28
29
30
};

#else

Paul's avatar
Paul committed
31
32
33
34
35
36
37
<%
interface('pass',
    virtual('name', returns='std::string', const=True),
    virtual('apply', returns='void', p='program &', const=True)
)
%>

Paul's avatar
Paul committed
38
39
#endif

Paul's avatar
Paul committed
40
} // namespace MIGRAPHX_INLINE_NS
Paul's avatar
Paul committed
41
} // namespace migraphx
Paul's avatar
Paul committed
42
43

#endif