1 /*
2 * Copyright (c) 2017-2023 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 #include "arm_compute/core/SubTensorInfo.h"
25
26 #include "arm_compute/core/Error.h"
27 #include "arm_compute/core/Helpers.h"
28 #include "arm_compute/core/Validate.h"
29
30 namespace arm_compute
31 {
32 namespace
33 {
34 /** Extends parent shape depending on subtensor's coordinates and shape
35 *
36 * @param parent_shape Parent shape
37 * @param shape Subtensor shape
38 * @param coords Subtensor coordinates inside parent tensor
39 *
40 * @return Extended parent shape
41 */
extend_parent_shape(TensorShape parent_shape,TensorShape shape,Coordinates coords)42 TensorShape extend_parent_shape(TensorShape parent_shape, TensorShape shape, Coordinates coords)
43 {
44 // Extend shape
45 for(unsigned int i = 0; i < TensorShape::num_max_dimensions; ++i)
46 {
47 int dimension_extend = coords[i] + static_cast<int>(shape[i]);
48 if((dimension_extend > static_cast<int>(parent_shape[i])) && (dimension_extend > 0))
49 {
50 parent_shape.set(i, static_cast<size_t>(dimension_extend));
51 }
52 }
53
54 return parent_shape;
55 }
56 } // namespace
57
SubTensorInfo()58 SubTensorInfo::SubTensorInfo()
59 : _parent(nullptr), _tensor_shape(), _dims_state(), _coords(), _valid_region{ Coordinates(), _tensor_shape }, _extend_parent(false), _lock_paddings(false)
60 {
61 }
62
SubTensorInfo(ITensorInfo * parent,TensorShape tensor_shape,Coordinates coords,bool extend_parent)63 SubTensorInfo::SubTensorInfo(ITensorInfo *parent, TensorShape tensor_shape, Coordinates coords, bool extend_parent)
64 : _parent(parent), _tensor_shape(tensor_shape), _dims_state(), _coords(coords), _valid_region{ Coordinates(), _tensor_shape }, _extend_parent(extend_parent), _lock_paddings(false)
65 {
66 ARM_COMPUTE_ERROR_ON(parent == nullptr);
67
68 // Check if subtensor is valid if parent is configured
69 if(parent->tensor_shape().total_size() != 0 && !_extend_parent)
70 {
71 ARM_COMPUTE_ERROR_ON_INVALID_SUBTENSOR(parent->tensor_shape(), coords, tensor_shape);
72 }
73
74 // Initialize valid region
75 _valid_region = ValidRegion{ Coordinates(), _tensor_shape };
76 }
77
clone() const78 std::unique_ptr<ITensorInfo> SubTensorInfo::clone() const
79 {
80 // Clone creates a TensorInfo object from SubTensorInfo's parent which will conclude to a TensorInfo
81 // For now it does not make sense to copy a SubTensorInfo explicitly
82 ARM_COMPUTE_ERROR_ON(_parent == nullptr);
83 auto clone_obj = _parent->clone();
84 clone_obj->set_tensor_shape(_tensor_shape);
85 clone_obj->set_valid_region(_valid_region);
86 return clone_obj;
87 }
88
set_tensor_shape(const TensorShape & shape)89 ITensorInfo &SubTensorInfo::set_tensor_shape(const TensorShape &shape)
90 {
91 ARM_COMPUTE_ERROR_ON(_parent == nullptr);
92
93 // Check if subtensor is valid if parent is configured
94 if(_parent->tensor_shape().total_size() != 0 && !_extend_parent)
95 {
96 ARM_COMPUTE_ERROR_ON_INVALID_SUBTENSOR(_parent->tensor_shape(), _coords, shape);
97 _valid_region = ValidRegion{ _coords, shape };
98 }
99 else if(_extend_parent) // Extend parent shape, configure if specified
100 {
101 ARM_COMPUTE_ERROR_ON((_parent->data_type() == DataType::UNKNOWN) && (_parent->format() == Format::UNKNOWN));
102 TensorShape parent_extended_shape = extend_parent_shape(_parent->tensor_shape(), shape, _coords);
103 _parent->set_tensor_shape(parent_extended_shape);
104 _parent->set_valid_region(ValidRegion{ Coordinates(), parent_extended_shape });
105 }
106 _tensor_shape = shape;
107 return *this;
108 }
109
set_tensor_dims_state(const TensorDimsState & state)110 ITensorInfo &SubTensorInfo::set_tensor_dims_state(const TensorDimsState &state)
111 {
112 ARM_COMPUTE_ERROR_ON(_parent == nullptr);
113 _dims_state = state;
114 return *this;
115 }
116
set_lock_paddings(bool flag)117 ITensorInfo &SubTensorInfo::set_lock_paddings(bool flag)
118 {
119 _lock_paddings = flag;
120 return *this;
121 }
122
lock_paddings() const123 bool SubTensorInfo::lock_paddings() const
124 {
125 return _lock_paddings;
126 }
127
extend_padding(const PaddingSize & padding)128 bool SubTensorInfo::extend_padding(const PaddingSize &padding)
129 {
130 ARM_COMPUTE_ERROR_ON(_lock_paddings);
131 ARM_COMPUTE_ERROR_ON(_parent == nullptr);
132 ARM_COMPUTE_ERROR_ON(!_parent->is_resizable());
133 ARM_COMPUTE_ERROR_ON(_parent->total_size() == 0);
134
135 // Check that you do not extend padding on sub-tensors unless XY shape matches parent tensor
136 if(!_extend_parent && (padding.left || padding.right))
137 {
138 ARM_COMPUTE_ERROR_ON(_parent->tensor_shape().x() != tensor_shape().x());
139 }
140 if(!_extend_parent && (padding.top || padding.bottom))
141 {
142 ARM_COMPUTE_ERROR_ON(_parent->tensor_shape().y() != tensor_shape().y());
143 }
144
145 // Extend parent padding if required
146 return _parent->extend_padding(padding);
147 }
148
offset_element_in_bytes(const Coordinates & pos) const149 int32_t SubTensorInfo::offset_element_in_bytes(const Coordinates &pos) const
150 {
151 ARM_COMPUTE_ERROR_ON_COORDINATES_DIMENSIONS_GTE(pos, _tensor_shape.num_dimensions());
152
153 int32_t offset = offset_first_element_in_bytes();
154 const Strides &strides = strides_in_bytes();
155
156 for(size_t i = 0; i < _tensor_shape.num_dimensions(); ++i)
157 {
158 offset += pos[i] * strides[i];
159 }
160
161 return offset;
162 }
163 } // namespace arm_compute
164