1 /* 2 * Copyright (c) 2019-2021 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_NESPACETOBATCHLAYER_H 25 #define ARM_COMPUTE_NESPACETOBATCHLAYER_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 #include <memory> 31 32 namespace arm_compute 33 { 34 class ITensor; 35 class ITensorInfo; 36 class NESpaceToBatchLayerKernel; 37 class NEFill; 38 39 /** Basic function to spatial divide a tensor. This function calls the following kernels/functions: 40 * 41 * -# @ref NEFill 42 * -# @ref NESpaceToBatchLayerKernel 43 */ 44 class NESpaceToBatchLayer : public IFunction 45 { 46 public: 47 /** Default constructor */ 48 NESpaceToBatchLayer(); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NESpaceToBatchLayer(const NESpaceToBatchLayer &) = delete; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NESpaceToBatchLayer &operator=(const NESpaceToBatchLayer &) = delete; 53 /** Allow instances of this class to be moved */ 54 NESpaceToBatchLayer(NESpaceToBatchLayer &&) = default; 55 /** Allow instances of this class to be moved */ 56 NESpaceToBatchLayer &operator=(NESpaceToBatchLayer &&) = default; 57 /** Default destructor */ 58 ~NESpaceToBatchLayer(); 59 /** Set the input and output tensors. 60 * 61 * Valid data layouts: 62 * - NHWC 63 * - NCHW 64 * 65 * Valid data type configurations: 66 * |src0 |src1 |src2 |dst | 67 * |:---------|:---------|:---------|:---------| 68 * |All |S32 |S32 |All | 69 * 70 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 71 * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32 72 * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32 73 * @param[out] output Tensor output. Data types supported: same as @p input 74 */ 75 void configure(const ITensor *input, const ITensor *block_shape, const ITensor *paddings, ITensor *output); 76 /** Set the input and output tensors. (Static block shape and paddings) 77 * 78 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 79 * @param[in] block_shape_x Block shape x value. 80 * @param[in] block_shape_y Block shape y value. 81 * @param[in] padding_left The padding at the beginning of every dimension of the output tensor. 82 * @param[in] padding_right The padding at the end of every dimension of the output tensor. 83 * @param[out] output Tensor output. Data types supported: same as @p input 84 */ 85 void configure(const ITensor *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, ITensor *output); 86 /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayer 87 * 88 * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All. 89 * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32 90 * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32 91 * @param[in] output Tensor output info. Data types supported: same as @p input 92 * 93 * @return a status 94 */ 95 static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output); 96 /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayer (Static block shape and paddings) 97 * 98 * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All. 99 * @param[in] block_shape_x Block shape x value. 100 * @param[in] block_shape_y Block shape y value. 101 * @param[in] padding_left The padding at the beginning of every dimension of the output tensor. 102 * @param[in] padding_right The padding at the end of every dimension of the output tensor. 103 * @param[in] output Tensor output info. Data types supported: same as @p input 104 * 105 * @return a status 106 */ 107 static Status validate(const ITensorInfo *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, const ITensorInfo *output); 108 109 // Inherited methods overridden: 110 void run() override; 111 112 private: 113 std::unique_ptr<NESpaceToBatchLayerKernel> _space_to_batch_kernel; /**< SpaceToBatch kernel to run */ 114 std::unique_ptr<NEFill> _fill_f; /**< Fill function to run */ 115 bool _has_padding; /**< Flag to check if the output has padding */ 116 }; 117 } // namespace arm_compute 118 #endif /* ARM_COMPUTE_NESPACETOBATCHLAYER_H */ 119