Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 1 | /* |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 2 | * Copyright (c) 2018-2021, 2023 Arm Limited. |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLBATCHTOSPACELAYERKERNEL_H |
| 25 | #define ARM_COMPUTE_CLBATCHTOSPACELAYERKERNEL_H |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 26 | |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/Types.h" |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 28 | #include "src/core/CL/ICLKernel.h" |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | class ICLTensor; |
| 33 | |
| 34 | /** Interface for the batch to space kernel */ |
| 35 | class CLBatchToSpaceLayerKernel : public ICLKernel |
| 36 | { |
| 37 | public: |
| 38 | /** Default constructor */ |
| 39 | CLBatchToSpaceLayerKernel(); |
| 40 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 41 | CLBatchToSpaceLayerKernel(const CLBatchToSpaceLayerKernel &) = delete; |
| 42 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 43 | CLBatchToSpaceLayerKernel &operator=(const CLBatchToSpaceLayerKernel &) = delete; |
| 44 | /** Allow instances of this class to be moved */ |
| 45 | CLBatchToSpaceLayerKernel(CLBatchToSpaceLayerKernel &&) = default; |
| 46 | /** Allow instances of this class to be moved */ |
| 47 | CLBatchToSpaceLayerKernel &operator=(CLBatchToSpaceLayerKernel &&) = default; |
| 48 | /** Default destructor */ |
| 49 | ~CLBatchToSpaceLayerKernel() = default; |
| 50 | /** Initialise the kernel's inputs and output. |
| 51 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 52 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 53 | * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32 |
| 54 | * @param[out] output Tensor output. Data types supported: same as @p input |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 55 | * |
| 56 | * @deprecated This method for dynamic block shape is not fully mature and will be removed in 23.08 release |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 57 | */ |
| 58 | void configure(const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output); |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 59 | /** Initialise the kernel's inputs and output. |
| 60 | * |
| 61 | * @param[in] compile_context The compile context to be used. |
| 62 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
| 63 | * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32 |
| 64 | * @param[out] output Tensor output. Data types supported: same as @p input |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 65 | * |
| 66 | * @deprecated This method for dynamic block shape is not fully mature and will be removed in 23.08 release |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 67 | */ |
Manuel Bottini | 256c0b9 | 2020-04-21 13:29:30 +0100 | [diff] [blame] | 68 | void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output); |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 69 | /** Initialise the kernel's inputs and output (Static block shape). |
| 70 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 71 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 72 | * @param[in] block_shape_x Block shape x value. |
| 73 | * @param[in] block_shape_y Block shape y value. |
| 74 | * @param[out] output Tensor output. Data types supported: same as @p input |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 75 | * @param[in] crop_info Specifies how the output shape is cropped after batch to space is performed |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 76 | */ |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 77 | void configure(const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output, const CropInfo &crop_info); |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 78 | /** Initialise the kernel's inputs and output (Static block shape). |
| 79 | * |
| 80 | * @param[in] compile_context The compile context to be used. |
| 81 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
| 82 | * @param[in] block_shape_x Block shape x value. |
| 83 | * @param[in] block_shape_y Block shape y value. |
| 84 | * @param[out] output Tensor output. Data types supported: same as @p input |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 85 | * @param[in] crop_info Specifies how the output shape is cropped after batch to space is performed |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 86 | */ |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 87 | void configure(const CLCompileContext &compile_context, const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output, const CropInfo &crop_info); |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 88 | /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayerKernel |
| 89 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 90 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 91 | * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32 |
| 92 | * @param[in] output Tensor output. Data types supported: same as @p input |
| 93 | * |
| 94 | * @return a status |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 95 | * |
| 96 | * @deprecated This method for dynamic block shape is not fully mature and will be removed in 23.08 release |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 97 | */ |
| 98 | static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output); |
| 99 | /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayerKernel (Static block shape). |
| 100 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 101 | * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All. |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 102 | * @param[in] block_shape_x Block shape x value. |
| 103 | * @param[in] block_shape_y Block shape y value. |
| 104 | * @param[in] output Tensor output. Data types supported: same as @p input |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 105 | * @param[in] crop_info Specifies how the output shape is cropped after batch to space is performed |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 106 | * |
| 107 | * @return a status |
| 108 | */ |
Omar Al Khatib | fff9a4c | 2023-03-28 11:14:29 +0100 | [diff] [blame] | 109 | static Status validate(const ITensorInfo *input, const int32_t block_shape_x, const int32_t block_shape_y, const ITensorInfo *output, const CropInfo &crop_info); |
Michalis Spyrou | 6a8d3b6 | 2018-08-31 10:07:09 +0100 | [diff] [blame] | 110 | |
| 111 | // Inherited methods overridden: |
| 112 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 113 | |
| 114 | private: |
| 115 | const ICLTensor *_input; /**< Source tensor */ |
| 116 | const ICLTensor *_block_shape; /**< Block shape tensor */ |
| 117 | ICLTensor *_output; /**< Destination tensor */ |
| 118 | }; |
| 119 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 120 | #endif /* ARM_COMPUTE_CLBATCHTOSPACELAYERKERNEL_H */ |