src/core/SubTensorInfo.cpp

   1 /*
   2  * Copyright (c) 2017-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 #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 #include "support/ToolchainSupport.h"
  30
  31 using namespace arm_compute;
  32
  33 namespace
  34 {
  35 /** Extends parent shape depending on subtensor's coordinates and shape
  36  *
  37  * @param parent_shape Parent shape
  38  * @param shape        Subtensor shape
  39  * @param coords       Subtensor coordinates inside parent tensor
  40  *
  41  * @return Extended parent shape
  42  */
  43 TensorShape extend_parent_shape(TensorShape parent_shape, TensorShape shape, Coordinates coords)
  44 {
  45     // Subtensor should not index in x, y dimensions.
  46     ARM_COMPUTE_ERROR_ON((coords.x() != 0) || (coords.y() != 0));
  47
  48     // Cannot extend on x, y ?
  49     ARM_COMPUTE_ERROR_ON((parent_shape.total_size() != 0) && (parent_shape.x() != shape.x()) && (parent_shape.y() != shape.y()));
  50
  51     // Extend shape
  52     for(unsigned int i = 0; i < TensorShape::num_max_dimensions; ++i)
  53     {
  54         int dimension_extend = coords[i] + static_cast<int>(shape[i]);
  55         if((dimension_extend > static_cast<int>(parent_shape[i])) && (dimension_extend > 0))
  56         {
  57             parent_shape.set(i, static_cast<size_t>(dimension_extend));
  58         }
  59     }
  60
  61     return parent_shape;
  62 }
  63 } // namespace
  64
  65 SubTensorInfo::SubTensorInfo()
  66     : _parent(nullptr), _tensor_shape(), _coords(), _valid_region{ Coordinates(), _tensor_shape }, _extend_parent(false)
  67 {
  68 }
  69
  70 SubTensorInfo::SubTensorInfo(ITensorInfo *parent, TensorShape tensor_shape, Coordinates coords, bool extend_parent)
  71     : _parent(parent), _tensor_shape(tensor_shape), _coords(coords), _valid_region{ Coordinates(), _tensor_shape }, _extend_parent(extend_parent)
  72 {
  73     ARM_COMPUTE_ERROR_ON(parent == nullptr);
  74     // Check if subtensor is valid if parent is configured
  75     if(parent->tensor_shape().total_size() != 0 && !_extend_parent)
  76     {
  77         ARM_COMPUTE_ERROR_ON_INVALID_SUBTENSOR(parent->tensor_shape(), coords, tensor_shape);
  78     }
  79
  80     // Initialize valid region
  81     _valid_region = ValidRegion{ Coordinates(), _tensor_shape };
  82 }
  83
  84 std::unique_ptr<ITensorInfo> SubTensorInfo::clone() const
  85 {
  86     // Clone creates a TensorInfo object from SubTensorInfo's parent which will conclude to a TensorInfo
  87     // For now it does not make sense to copy a SubTensorInfo explicitly
  88     ARM_COMPUTE_ERROR_ON(_parent == nullptr);
  89     auto clone_obj = _parent->clone();
  90     clone_obj->set_tensor_shape(_tensor_shape);
  91     clone_obj->set_valid_region(_valid_region);
  92     return clone_obj;
  93 }
  94
  95 ITensorInfo &SubTensorInfo::set_tensor_shape(const TensorShape &shape)
  96 {
  97     ARM_COMPUTE_ERROR_ON(_parent == nullptr);
  98
  99     // Check if subtensor is valid if parent is configured
 100     if(_parent->tensor_shape().total_size() != 0 && !_extend_parent)
 101     {
 102         ARM_COMPUTE_ERROR_ON_INVALID_SUBTENSOR(_parent->tensor_shape(), _coords, shape);
 103         _valid_region = ValidRegion{ _coords, shape };
 104     }
 105     else if(_extend_parent) // Extend parent shape, configure if specified
 106     {
 107         ARM_COMPUTE_ERROR_ON((_parent->data_type() == DataType::UNKNOWN) && (_parent->format() == Format::UNKNOWN));
 108         TensorShape parent_extended_shape = extend_parent_shape(_parent->tensor_shape(), shape, _coords);
 109         _parent->set_tensor_shape(parent_extended_shape);
 110         _parent->set_valid_region(ValidRegion{ Coordinates(), parent_extended_shape });
 111     }
 112     _tensor_shape = shape;
 113     return *this;
 114 }
 115
 116 bool SubTensorInfo::extend_padding(const PaddingSize &padding)
 117 {
 118     ARM_COMPUTE_ERROR_ON(_parent == nullptr);
 119     ARM_COMPUTE_ERROR_ON(!_parent->is_resizable());
 120     ARM_COMPUTE_ERROR_ON(_parent->total_size() == 0);
 121
 122     // Extend parent padding if required
 123     return _parent->extend_padding(padding);
 124 }
 125
 126 size_t SubTensorInfo::offset_element_in_bytes(const Coordinates &pos) const
 127 {
 128     ARM_COMPUTE_ERROR_ON_COORDINATES_DIMENSIONS_GTE(pos, _tensor_shape.num_dimensions());
 129
 130     size_t         offset  = offset_first_element_in_bytes();
 131     const Strides &strides = strides_in_bytes();
 132
 133     for(size_t i = 0; i < _tensor_shape.num_dimensions(); ++i)
 134     {
 135         offset += pos[i] * strides[i];
 136     }
 137
 138     return offset;
 139 }