1 /* 2 * Copyright (c) 2018-2020 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_CLBATCHTOSPACELAYER_H 25 #define ARM_COMPUTE_CLBATCHTOSPACELAYER_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 class CLCompileContext; 36 class ITensorInfo; 37 class CLBatchToSpaceLayerKernel; 38 class ICLTensor; 39 40 /** Basic function to run @ref CLBatchToSpaceLayerKernel. */ 41 class CLBatchToSpaceLayer : public IFunction 42 { 43 public: 44 /** Default constructor */ 45 CLBatchToSpaceLayer(); 46 /** Prevent instances of this class from being copied */ 47 CLBatchToSpaceLayer(const CLBatchToSpaceLayer &) = delete; 48 /** Prevent instances of this class from being copied */ 49 CLBatchToSpaceLayer &operator=(const CLBatchToSpaceLayer &) = delete; 50 /** Prevent instances of this class to be moved */ 51 CLBatchToSpaceLayer(CLBatchToSpaceLayer &&) = delete; 52 /** Prevent instances of this class to be moved */ 53 CLBatchToSpaceLayer &operator=(CLBatchToSpaceLayer &&) = delete; 54 /** Default destructor */ 55 ~CLBatchToSpaceLayer(); 56 /** Set the input and output tensors. 57 * 58 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 59 * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32 60 * @param[out] output Tensor output. Data types supported: same as @p input 61 */ 62 void configure(const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output); 63 /** Set the input and output tensors. 64 * 65 * @param[in] compile_context The compile context to be used. 66 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 67 * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32 68 * @param[out] output Tensor output. Data types supported: same as @p input 69 */ 70 void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output); 71 /** Set the input and output tensors. (Static block shape). 72 * 73 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 74 * @param[in] block_shape_x Block shape x value. 75 * @param[in] block_shape_y Block shape y value. 76 * @param[out] output Tensor output. Data types supported: same as @p input 77 */ 78 void configure(const ICLTensor *input, int32_t block_shape_x, int32_t block_shape_y, ICLTensor *output); 79 /** Set the input and output tensors. (Static block shape). 80 * 81 * @param[in] compile_context The compile context to be used. 82 * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. 83 * @param[in] block_shape_x Block shape x value. 84 * @param[in] block_shape_y Block shape y value. 85 * @param[out] output Tensor output. Data types supported: same as @p input 86 */ 87 void configure(const CLCompileContext &compile_context, const ICLTensor *input, int32_t block_shape_x, int32_t block_shape_y, ICLTensor *output); 88 /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayer 89 * 90 * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All. 91 * @param[in] block_shape block shape tensor info with shape [M]. Data types supported: S32 92 * @param[out] output Tensor output info. Data types supported: same as @p input 93 * 94 * @return a status 95 */ 96 static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output); 97 /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayer (Static block shape). 98 * 99 * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All. 100 * @param[in] block_shape_x Block shape x value. 101 * @param[in] block_shape_y Block shape y value. 102 * @param[out] output Tensor output info. Data types supported: same as @p input 103 * 104 * @return a status 105 */ 106 static Status validate(const ITensorInfo *input, int32_t block_shape_x, int32_t block_shape_y, const ITensorInfo *output); 107 108 // Inherited methods overridden: 109 void run() override; 110 111 private: 112 std::unique_ptr<CLBatchToSpaceLayerKernel> _batch_to_space_kernel; /**< CLBatchToSpaceLayerKernel to run */ 113 }; 114 } // namespace arm_compute 115 #endif /* ARM_COMPUTE_CLBATCHTOSPACELAYER_H */ 116