summaryrefslogtreecommitdiff
path: root/compiler/loco/include/loco/IR/FeatureIndex.h
blob: 007f944911bc7458739713d866e62e1d4144b01e (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
/*
 * 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.
 */

#ifndef __LOCO_IR_FEATURE_INDEX_H__
#define __LOCO_IR_FEATURE_INDEX_H__

#include <cstdint>

namespace loco
{

/**
 * \brief Feature Index
 *
 * Feature Index indicates an "element" in a given feature map.
 *
 * Let us assume that there is a feature map F and S denotes its shape (of FeatureShape type).
 *
 * Then, any valid feature index I satisfies the following invariants:
 * - 0 <= I.batch()   < S.count()
 * - 0 <= I.channel() < S.depth()
 * - 0 <= I.row()     < S.height()
 * - 0 <= I.column()  < S.width()
 */
class FeatureIndex final
{
public:
  FeatureIndex() = default;

public:
  const uint32_t &batch(void) const { return _batch; }
  uint32_t &batch(void) { return _batch; }

  const uint32_t &channel(void) const { return _channel; }
  uint32_t &channel(void) { return _channel; }

  const uint32_t &row(void) const { return _row; }
  uint32_t &row(void) { return _row; }

  const uint32_t &column(void) const { return _column; }
  uint32_t &column(void) { return _column; }

private:
  uint32_t _batch = 0;
  uint32_t _channel = 0;
  uint32_t _row = 0;
  uint32_t _column = 0;
};

} // namespace loco

#endif // __LOCO_IR_FEATURE_INDEX_H__