Compute Library
 19.08
ITensorInfo.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2018 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_ITENSORINFO_H__
25 #define __ARM_COMPUTE_ITENSORINFO_H__
26 
30 #include "arm_compute/core/Types.h"
31 #include "arm_compute/core/Utils.h"
34 
35 #include <cstddef>
36 
37 namespace arm_compute
38 {
40 class ITensorInfo : public misc::ICloneable<ITensorInfo>
41 {
42 public:
44  virtual ~ITensorInfo() = default;
62  virtual ITensorInfo &set_num_channels(int num_channels) = 0;
73  virtual ITensorInfo &set_format(Format format) = 0;
83  virtual ITensorInfo &set_tensor_shape(const TensorShape &shape) = 0;
102  virtual ITensorInfo &reset_padding() = 0;
109  virtual bool auto_padding() = 0;
118  virtual bool extend_padding(const PaddingSize &padding) = 0;
125  virtual size_t dimension(size_t index) const = 0;
132  virtual size_t dimension(DataLayoutDimension dimension) const = 0;
137  virtual const Strides &strides_in_bytes() const = 0;
143  virtual size_t offset_first_element_in_bytes() const = 0;
151  virtual size_t offset_element_in_bytes(const Coordinates &pos) const = 0;
152 
157  virtual size_t element_size() const = 0;
162  virtual size_t num_dimensions() const = 0;
167  virtual size_t num_channels() const = 0;
172  virtual const TensorShape &tensor_shape() const = 0;
177  virtual DataType data_type() const = 0;
182  virtual Format format() const = 0;
187  virtual size_t total_size() const = 0;
192  virtual PaddingSize padding() const = 0;
197  virtual bool has_padding() const = 0;
202  virtual bool is_resizable() const = 0;
209  virtual ITensorInfo &set_is_resizable(bool is_resizable) = 0;
214  virtual ValidRegion valid_region() const = 0;
219  virtual void set_valid_region(const ValidRegion &valid_region) = 0;
220 
225  virtual QuantizationInfo quantization_info() const = 0;
230  virtual DataLayout data_layout() const = 0;
231 
246  template <typename... Infos>
247  static std::pair<TensorShape, ValidRegion> broadcast_shape_and_valid_region(const Infos &... infos)
248  {
249  TensorShape bc_shape = TensorShape::broadcast_shape(infos.tensor_shape()...);
250  ValidRegion bc_valid_region{ Coordinates(), bc_shape };
251 
252  auto broadcast_valid_region = [&bc_valid_region](const ITensorInfo & info)
253  {
254  if(info.num_dimensions() != 0)
255  {
256  for(size_t d = 0; d < bc_valid_region.shape.num_dimensions(); ++d)
257  {
258  const bool is_broadcast = (info.tensor_shape()[d] == 1);
259 
260  const int anchor_max = std::max(bc_valid_region.anchor[d], info.valid_region().anchor[d]);
261  const size_t valid_min = std::min(bc_valid_region.shape[d], info.valid_region().shape[d]);
262 
263  if(!is_broadcast || (valid_min == 0))
264  {
265  bc_valid_region.anchor.set(d, anchor_max);
266  bc_valid_region.shape.set(d, valid_min);
267  }
268  }
269  }
270  };
271 
272  utility::for_each(broadcast_valid_region, infos...);
273 
274  return std::pair<TensorShape, ValidRegion>(bc_shape, bc_valid_region);
275  }
276 };
277 }
278 #endif /*__ARM_COMPUTE_TENSORINFO_H__ */
virtual size_t num_dimensions() const =0
The number of dimensions of the tensor (rank)
virtual ITensorInfo & set_num_channels(int num_channels)=0
Set the number of channels to the specified value.
Shape of a tensor.
Definition: TensorShape.h:39
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
Container for 2D border size.
Definition: Types.h:259
virtual ITensorInfo & set_tensor_shape(const TensorShape &shape)=0
Set the shape of an already initialized tensor.
DataLayoutDimension
[DataLayout enum definition]
Definition: Types.h:123
virtual DataType data_type() const =0
Data type used for each element of the tensor.
static TensorShape broadcast_shape(const Shapes &... shapes)
If shapes are broadcast compatible, return the broadcasted shape.
Definition: TensorShape.h:210
virtual size_t offset_element_in_bytes(const Coordinates &pos) const =0
The offset in bytes from the beginning of the memory allocation to access the element at position (x,...
Store the tensor's metadata.
Definition: ITensorInfo.h:40
virtual ITensorInfo & reset_padding()=0
Resets the padding settings of the tensor.
static std::pair< TensorShape, ValidRegion > broadcast_shape_and_valid_region(const Infos &... infos)
If infos are broadcast compatible tensor info's, return the broadcasted shape and the intersection of...
Definition: ITensorInfo.h:247
Copyright (c) 2017-2018 ARM Limited.
virtual void set_valid_region(const ValidRegion &valid_region)=0
Set the valid region of the tensor.
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
virtual bool is_resizable() const =0
Flag indicating whether the size of the tensor can be changed.
Quantization information.
virtual Format format() const =0
Colour format of the image.
virtual bool auto_padding()=0
Update the offset to the first element and the strides to automatically computed values.
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
virtual ITensorInfo & set_data_layout(const DataLayout &data_layout)=0
Set the data layout of the tensor.
Format
Image colour formats.
Definition: Types.h:52
Coordinates of an item.
Definition: Coordinates.h:37
virtual size_t element_size() const =0
Element size in bytes calculated as data_size() * num_channels()
virtual PaddingSize padding() const =0
Padding of tensor.
virtual ITensorInfo & set_quantization_info(const QuantizationInfo &quantization_info)=0
Set the quantization settings (scale and offset) of the tensor.
virtual ITensorInfo & set_data_type(DataType data_type)=0
Set the data type to the specified value.
virtual QuantizationInfo quantization_info() const =0
Get the quantization settings (scale and offset) of the tensor.
void for_each(F &&)
Base case of for_each.
Definition: Utility.h:93
Strides of an item in bytes.
Definition: Strides.h:37
virtual size_t offset_first_element_in_bytes() const =0
The offset from the beginning of the memory allocation to the first element of the tensor.
virtual size_t total_size() const =0
Returns the total size of the tensor in bytes.
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:78
virtual const Strides & strides_in_bytes() const =0
The strides in bytes for accessing each dimension of the tensor.
Clonable Interface.
Definition: ICloneable.h:35
Container for valid region of a window.
Definition: Types.h:174
virtual ITensorInfo & set_format(Format format)=0
Set the format of an already initialized tensor.
DataType
Available data types.
Definition: Types.h:74
virtual ~ITensorInfo()=default
Default virtual destructor.
DataLayout
[DataLayout enum definition]
Definition: Types.h:114
virtual bool extend_padding(const PaddingSize &padding)=0
Update the offset to the first element, the strides and the total size.
virtual size_t num_channels() const =0
The number of channels for each tensor element.
virtual bool has_padding() const =0
Checks if the tensor has been allocated with padding or not.
virtual ITensorInfo & set_is_resizable(bool is_resizable)=0
Set the flag whether the tensor size can be changed.
virtual DataLayout data_layout() const =0
Get the data layout of the tensor.