summaryrefslogtreecommitdiff
path: root/libs/misc/include/misc/tensor/Index.h
blob: a08d7099ea4d9358b12265c74bfeea5e69deaee1 (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
/*
 * Copyright (c) 2018 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 Index.h
 * @ingroup COM_AI_RUNTIME
 * @brief This file contains nnfw::misc::tensor::Index struct
 */
#ifndef __NNFW_MISC_TENSOR_INDEX_H__
#define __NNFW_MISC_TENSOR_INDEX_H__

#include <cstdint>
#include <cstddef>

#include <vector>
#include <initializer_list>

namespace nnfw
{
namespace misc
{
namespace tensor
{

/**
 * @brief Struct to represent index of each dimension of a tensor
 */
struct Index
{
public:
  /**
   * @brief Construct a new @c Index object
   * @param[in] rank    Rank of a tensor
   */
  Index(size_t rank) { _offsets.resize(rank); }

public:
  /**
   * @brief Construct a new @c Index object
   * @param[in] offsets    Rank of a tensor of @c std::initializer_list<int32_t> type
   */
  Index(std::initializer_list<int32_t> offsets) : _offsets{offsets}
  {
    // DO NOTHING
  }

public:
  /**
   * @brief Get the rank
   * @return Rank that this @c Index object can handle
   */
  size_t rank(void) const { return _offsets.size(); }

public:
  /**
   * @brief Get the index n'th dimension
   * @param[in] n   Dimension
   * @return index of n'th dimension
   */
  int32_t at(size_t n) const { return _offsets.at(n); }

  /**
   * @brief Get the reference of the index n'th dimension
   * @param[in] n   Dimension
   * @return reference of index of n'th dimension
   */
  int32_t &at(size_t n) { return _offsets.at(n); }

private:
  std::vector<int32_t> _offsets;
};

/**
 * @brief Copy an @c Index with reversed order
 * @param[in] origin    @c Index object to copy
 * @return  an @c Index object with reversed order
 * @note    This is used to convert NNAPI tensor index to ARM tensor index or vice versa
 */
inline static Index copy_reverse(const Index &origin)
{
  size_t rank = origin.rank();
  Index target(rank);
  for (int i = 0; i < rank; i++)
    target.at(i) = origin.at(rank - 1 - i);
  return target;
}

} // namespace tensor
} // namespace misc
} // namespace nnfw

#endif // __NNFW_MISC_TENSOR_INDEX_H__