summaryrefslogtreecommitdiff
path: root/runtimes/neurun/core/include/graph/operand/PermuteFactor.h
blob: 480e95c1512613a48a6c9e001e4c4811dd63f517 (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
 * Copyright (c) 2019 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.
 */

/**
 * @file     PermuteFactor.h
 * @brief    This file contains neurun::graph::operand::PermuteFactor class
 * @ingroup  COM_AI_RUNTIME
 */

#ifndef __NEURUN_GRAPH_OPERAND_PERMUTE_FACTOR_H__
#define __NEURUN_GRAPH_OPERAND_PERMUTE_FACTOR_H__

#include <functional>

#include "model/Layout.h"

namespace neurun
{
namespace backend
{
class Backend;
} // namespace backend
} // namespace neurun

namespace neurun
{
namespace graph
{
namespace operand
{

/**
 * @brief Class that has factors of permutation
 */
class PermuteFactor
{
public:
  /**
   * @brief Construct PermuteFactor object.
   * @param backend  The backend factor
   * @param backend  The layout factor
   */
  PermuteFactor(const backend::Backend *backend, model::Layout layout)
      : _backend{backend}, _layout{layout}
  {
    // DO NOTHING
  }
  /**
   * @brief Construct PermuteFactor object by copy semantics.
   */
  PermuteFactor(const PermuteFactor &f) : _backend{f._backend}, _layout{f._layout}
  {
    // DO NOTHING
  }
  /**
   * @brief Construct PermuteFactor object by move semantics.
   */
  PermuteFactor(PermuteFactor &&) = default;

public:
  /**
   * @brief Get backend
   *
   * @return Backend factor
   */
  const backend::Backend *backend() const { return _backend; }
  /**
   * @brief Get layout
   *
   * @return Layout factor
   */
  model::Layout layout() const { return _layout; }

public:
  /**
   * @brief operator overloading function for `==`
   *
   * @return Whether two PermuteFactor are the same
   */
  bool operator==(const PermuteFactor &other) const
  {
    return _backend == other.backend() && _layout == other.layout();
  }
  /**
   * @brief operator overloading function for `!=`
   *
   * @return Whether two PermuteFactor are differenct
   */
  bool operator!=(const PermuteFactor &other) const { return !(*this == other); }

private:
  const backend::Backend *_backend{nullptr};
  model::Layout _layout{model::Layout::UNKNOWN};
};

} // namespace operand
} // namespace graph
} // namespace neurun

namespace std
{

using PermuteFactor = ::neurun::graph::operand::PermuteFactor;

/**
 * @brief Structure that provides hash value of PermuteFactor
 */
template <> struct hash<PermuteFactor>
{
  size_t operator()(const PermuteFactor &factor) const noexcept
  {
    hash<const ::neurun::backend::Backend *> b_hash{};
    hash<::neurun::model::Layout> l_hash{};
    return b_hash(factor.backend()) ^ (l_hash(factor.layout()) << 1);
  }
};

} // namespace std

#endif // __NEURUN_GRAPH_OPERAND_PERMUTE_FACTOR_H__