Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 ARM Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | #ifndef __ARM_COMPUTE_DIMENSIONS_H__ |
| 25 | #define __ARM_COMPUTE_DIMENSIONS_H__ |
| 26 | |
| 27 | #include "arm_compute/core/Error.h" |
| 28 | |
| 29 | #include <algorithm> |
| 30 | #include <array> |
| 31 | #include <functional> |
| 32 | #include <numeric> |
| 33 | |
| 34 | namespace arm_compute |
| 35 | { |
| 36 | /* Constant value used to indicate maximum dimensions of a Window, TensorShape and Coordinates */ |
| 37 | constexpr size_t MAX_DIMS = 6; |
| 38 | |
| 39 | /** Dimensions with dimensionality */ |
| 40 | template <typename T> |
| 41 | class Dimensions |
| 42 | { |
| 43 | public: |
| 44 | /** Number of dimensions the tensor has */ |
| 45 | static constexpr size_t num_max_dimensions = MAX_DIMS; |
| 46 | |
| 47 | /** Constructor to initialize the tensor shape. |
| 48 | * |
| 49 | * @param[in] dims Values to initialize the dimensions. |
| 50 | */ |
| 51 | template <typename... Ts> |
Moritz Pflanzer | b6c8d24 | 2017-07-18 13:42:54 +0100 | [diff] [blame^] | 52 | explicit Dimensions(Ts... dims) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 53 | : _id{ { dims... } }, _num_dimensions{ sizeof...(dims) } |
| 54 | { |
| 55 | } |
| 56 | |
| 57 | /** Allow instances of this class to be copy constructed */ |
| 58 | Dimensions(const Dimensions &) = default; |
| 59 | |
| 60 | /** Allow instances of this class to be copied */ |
| 61 | Dimensions &operator=(const Dimensions &) = default; |
| 62 | |
| 63 | /** Allow instances of this class to be move constructed */ |
| 64 | Dimensions(Dimensions &&) = default; |
| 65 | |
| 66 | /** Allow instances of this class to be moved */ |
| 67 | Dimensions &operator=(Dimensions &&) = default; |
| 68 | |
| 69 | /** Accessor to set the value of one of the dimensions. |
| 70 | * |
| 71 | * @param[in] dimension Dimension for which the value is set. |
| 72 | * @param[in] value Value to be set for the dimension. |
| 73 | */ |
| 74 | void set(size_t dimension, T value) |
| 75 | { |
| 76 | ARM_COMPUTE_ERROR_ON(dimension >= num_max_dimensions); |
| 77 | _id[dimension] = value; |
| 78 | _num_dimensions = std::max(_num_dimensions, dimension + 1); |
| 79 | } |
| 80 | /** Alias to access the size of the first dimension */ |
| 81 | T x() const |
| 82 | { |
| 83 | return _id[0]; |
| 84 | } |
| 85 | /** Alias to access the size of the second dimension */ |
| 86 | T y() const |
| 87 | { |
| 88 | return _id[1]; |
| 89 | } |
| 90 | /** Alias to access the size of the third dimension */ |
| 91 | T z() const |
| 92 | { |
| 93 | return _id[2]; |
| 94 | } |
| 95 | /** Generic accessor to get the size of any dimension |
| 96 | * |
| 97 | * @note Precondition: dimension < Dimensions::num_max_dimensions |
| 98 | * |
| 99 | * @param[in] dimension Dimension of the wanted size |
| 100 | * |
| 101 | * @return The size of the requested dimension. |
| 102 | */ |
| 103 | T operator[](size_t dimension) const |
| 104 | { |
| 105 | ARM_COMPUTE_ERROR_ON(dimension >= num_max_dimensions); |
| 106 | return _id[dimension]; |
| 107 | } |
| 108 | /** Returns the effective dimensionality of the tensor */ |
| 109 | unsigned int num_dimensions() const |
| 110 | { |
| 111 | return _num_dimensions; |
| 112 | } |
| 113 | |
| 114 | /** Set number of dimensions */ |
| 115 | void set_num_dimensions(size_t num_dimensions) |
| 116 | { |
| 117 | _num_dimensions = num_dimensions; |
| 118 | } |
| 119 | |
| 120 | /** Collapse dimensions. |
| 121 | * |
| 122 | * @param[in] first Dimensions into which the following @p n are collapsed. |
| 123 | * @param[in] n Number of dimensions to collapse into @p first. |
| 124 | */ |
| 125 | void collapse(size_t n, size_t first = 0) |
| 126 | { |
| 127 | ARM_COMPUTE_ERROR_ON(first + n > _id.size()); |
| 128 | |
Moritz Pflanzer | 1b31afc | 2017-07-05 15:54:42 +0100 | [diff] [blame] | 129 | if(n == 0) |
| 130 | { |
| 131 | return; |
| 132 | } |
| 133 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 134 | // Collapse dimensions into the first |
| 135 | _id[first] = std::accumulate(_id.cbegin() + first, _id.cbegin() + first + n, 1, std::multiplies<T>()); |
| 136 | // Shift the remaining dimensions down |
| 137 | std::copy(_id.begin() + first + n, _id.end(), _id.begin() + first + 1); |
| 138 | // Reduce the number of dimensions |
Moritz Pflanzer | 1b31afc | 2017-07-05 15:54:42 +0100 | [diff] [blame] | 139 | _num_dimensions -= std::min(n, _num_dimensions) - 1; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 140 | // Fill the now empty dimensions with zero |
| 141 | std::fill(_id.begin() + _num_dimensions, _id.end(), 0); |
| 142 | } |
| 143 | |
| 144 | /** Returns a read/write iterator that points to the first element in the dimension array. */ |
| 145 | typename std::array<T, num_max_dimensions>::iterator begin() |
| 146 | { |
| 147 | return _id.begin(); |
| 148 | } |
| 149 | /** Returns a read-only (constant) iterator that points to the first element in the dimension array. */ |
| 150 | typename std::array<T, num_max_dimensions>::const_iterator begin() const |
| 151 | { |
| 152 | return _id.begin(); |
| 153 | } |
| 154 | /** Returns a read-only (constant) iterator that points to the first element in the dimension array. */ |
| 155 | typename std::array<T, num_max_dimensions>::const_iterator cbegin() const |
| 156 | { |
| 157 | return begin(); |
| 158 | } |
| 159 | /** Returns a read/write iterator that points one past the last element in the dimension array. */ |
| 160 | typename std::array<T, num_max_dimensions>::iterator end() |
| 161 | { |
| 162 | return _id.end(); |
| 163 | } |
| 164 | /** Returns a read-only (constant) iterator that points one past the last element in the dimension array. */ |
| 165 | typename std::array<T, num_max_dimensions>::const_iterator end() const |
| 166 | { |
| 167 | return _id.end(); |
| 168 | } |
| 169 | /** Returns a read-only (constant) iterator that points one past the last element in the dimension array. */ |
| 170 | typename std::array<T, num_max_dimensions>::const_iterator cend() const |
| 171 | { |
| 172 | return end(); |
| 173 | } |
| 174 | |
| 175 | protected: |
| 176 | /** Protected destructor. */ |
| 177 | ~Dimensions() = default; |
| 178 | |
| 179 | std::array<T, num_max_dimensions> _id; |
| 180 | size_t _num_dimensions{ 0 }; |
| 181 | }; |
| 182 | } |
| 183 | #endif /*__ARM_COMPUTE_DIMENSIONS_H__*/ |