Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [diff] [blame] | 1 | /* |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 2 | * Copyright (c) 2018-2020 ARM Limited. |
Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [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 | */ |
| 24 | |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 25 | #ifndef ARM_COMPUTE_CLSTACKLAYERKERNEL_H |
| 26 | #define ARM_COMPUTE_CLSTACKLAYERKERNEL_H |
Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [diff] [blame] | 27 | |
| 28 | #include "arm_compute/core/CL/ICLKernel.h" |
| 29 | #include "arm_compute/core/Types.h" |
| 30 | |
| 31 | namespace arm_compute |
| 32 | { |
| 33 | class ICLTensor; |
| 34 | |
| 35 | /** OpenCL kernel to stacks a rank-R tensor into one with rank-(R+1) along the axis dimension.*/ |
| 36 | class CLStackLayerKernel : public ICLKernel |
| 37 | { |
| 38 | public: |
| 39 | /** Default constructor */ |
| 40 | CLStackLayerKernel(); |
| 41 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 42 | CLStackLayerKernel(const CLStackLayerKernel &) = delete; |
| 43 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 44 | CLStackLayerKernel &operator=(const CLStackLayerKernel &) = delete; |
| 45 | /** Allow instances of this class to be moved */ |
| 46 | CLStackLayerKernel(CLStackLayerKernel &&) = default; |
| 47 | /** Allow instances of this class to be moved */ |
| 48 | CLStackLayerKernel &operator=(CLStackLayerKernel &&) = default; |
| 49 | /** Default destructor */ |
| 50 | ~CLStackLayerKernel() = default; |
| 51 | /** Initialise the kernel's inputs and output |
| 52 | * |
Isabella Gottardi | ee7c15d | 2018-12-17 16:15:34 +0000 | [diff] [blame] | 53 | * @note Supported input tensor rank: up to 4 |
| 54 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 55 | * @param[in] input Input tensor. Data types supported: All. |
Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [diff] [blame] | 56 | * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions. |
| 57 | * @param[in] idx_input Index of the input tensor in the list of tensors to stack. |
| 58 | * All tensors in the list must have the same shape |
| 59 | * @param[in] num_tensors Number of tensors to stack |
| 60 | * @param[out] output Output tensor. Data types supported: Same as @p input. |
| 61 | * |
| 62 | */ |
| 63 | void configure(const ICLTensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ICLTensor *output); |
Manuel Bottini | 4c6bd51 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 64 | /** Initialise the kernel's inputs and output |
| 65 | * |
| 66 | * @note Supported input tensor rank: up to 4 |
| 67 | * |
| 68 | * @param[in] compile_context The compile context to be used. |
| 69 | * @param[in] input Input tensor. Data types supported: All. |
| 70 | * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions. |
| 71 | * @param[in] idx_input Index of the input tensor in the list of tensors to stack. |
| 72 | * All tensors in the list must have the same shape |
| 73 | * @param[in] num_tensors Number of tensors to stack |
| 74 | * @param[out] output Output tensor. Data types supported: Same as @p input. |
| 75 | * |
| 76 | */ |
Manuel Bottini | 2803f70 | 2020-04-21 16:20:03 +0100 | [diff] [blame] | 77 | void configure(const CLCompileContext &compile_context, const ICLTensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ICLTensor *output); |
Isabella Gottardi | ee7c15d | 2018-12-17 16:15:34 +0000 | [diff] [blame] | 78 | /** Static function to check if given info will lead to a valid configuration of @ref CLStackLayerKernel |
| 79 | * |
| 80 | * @note Supported input tensor rank: up to 4 |
Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [diff] [blame] | 81 | * |
Manuel Bottini | 8481d83 | 2019-12-10 15:28:40 +0000 | [diff] [blame] | 82 | * @param[in] input Input tensor info. Data types supported: All. |
Gian Marco Iodice | 8aa985e | 2018-11-27 15:58:08 +0000 | [diff] [blame] | 83 | * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions. |
| 84 | * @param[in] idx_input Index of the input tensor in the list of tensors to stack |
| 85 | * All tensors in the list must have the same shape |
| 86 | * @param[in] num_tensors Number of tensors to stack |
| 87 | * @param[in] output Output tensor info. Data types supported: Same as @p input. |
| 88 | * |
| 89 | * @return a status |
| 90 | */ |
| 91 | static Status validate(const ITensorInfo *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, const ITensorInfo *output); |
| 92 | |
| 93 | // Inherited methods overridden: |
| 94 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 95 | |
| 96 | private: |
| 97 | const ICLTensor *_input; |
| 98 | ICLTensor *_output; |
| 99 | }; |
| 100 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 101 | #endif /* ARM_COMPUTE_CLSTACKLAYERKERNEL_H */ |