summaryrefslogtreecommitdiff
path: root/compiler/luci/lang/include/luci/IR/LuciNodeMixins.h
blob: b18ac5dc4be2153fb050536890b045bb400fa14d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
 * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __LUCI_IR_LUCINODEMIXINS_H__
#define __LUCI_IR_LUCINODEMIXINS_H__

#include "luci/IR/AttrFusedActFunc.h"

#include <loco/IR/Node.h>
#include <loco/IR/NodeMixins.h>

namespace luci
{

/// @brief enumeration of mixin class
enum class LuciNodeTrait
{
  FusedActFunc,
  Bias
};

template <LuciNodeTrait T> class LuciNodeMixin;

template <> class LuciNodeMixin<LuciNodeTrait::FusedActFunc>
{
public:
  LuciNodeMixin() = default;

public:
  FusedActFunc fusedActivationFunction() const { return _fused_act_fun; }
  void fusedActivationFunction(FusedActFunc fused_act_fun) { _fused_act_fun = fused_act_fun; }

private:
  FusedActFunc _fused_act_fun = FusedActFunc::UNDEFINED;
};

/**
 * @brief Mixin class for nodes that has a bias input
 */
template <> class LuciNodeMixin<LuciNodeTrait::Bias>
{
public:
  LuciNodeMixin() = default;

public:
  virtual loco::Node *bias(void) const = 0; /// @brief get the input for bias.
  virtual void bias(loco::Node *node) = 0;  /// @brief set the input for bias.
};

/**
 * @brief Nodes with the fixed number of inputs
 *
 * TODO Deprecated this class, and use loco::FixedArity instead
 */
template <unsigned N, typename Base> class FixedArityNode : public Base
{
public:
  FixedArityNode()
  {
    for (uint32_t n = 0; n < N; ++n)
    {
      _args[n] = std::make_unique<loco::Use>(this);
    }
  }

  virtual ~FixedArityNode() = default;

public:
  unsigned arity(void) const final { return N; }

  loco::Node *arg(uint32_t n) const final { return _args.at(n)->node(); }

  void drop(void) final
  {
    for (uint32_t n = 0; n < N; ++n)
    {
      _args.at(n)->node(nullptr);
    }
  }

protected:
  // This API allows inherited classes to access "_args" field.
  loco::Use *at(unsigned n) const { return _args.at(n).get(); }

private:
  std::array<std::unique_ptr<loco::Use>, N> _args;
};

} // namespace luci

#endif // __LUCI_IR_LUCINODEMIXINS_H__