1 /* 2 * Copyright (c) 2018-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_NESTACKLAYER_H 25 #define ARM_COMPUTE_NESTACKLAYER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/IFunction.h" 29 30 #include <memory> 31 #include <vector> 32 33 namespace arm_compute 34 { 35 class ITensor; 36 class ITensorInfo; 37 class NEStackLayerKernel; 38 39 /** Basic function to stack tensors along an axis. This function calls the following kernel: 40 * 41 * -# @ref NEStackLayerKernel 42 * 43 */ 44 class NEStackLayer : public IFunction 45 { 46 public: 47 /** Default constructor */ 48 NEStackLayer(); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEStackLayer(const NEStackLayer &) = delete; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEStackLayer &operator=(const NEStackLayer &) = delete; 53 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 54 NEStackLayer(NEStackLayer &&) = delete; 55 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 56 NEStackLayer &operator=(NEStackLayer &&) = delete; 57 /** Default destructor */ 58 ~NEStackLayer(); 59 /** Initialise the kernel's inputs vector and output. 60 * 61 * Valid data layouts: 62 * - All 63 * 64 * Valid data type configurations: 65 * |src |dst | 66 * |:--------------|:--------------| 67 * |All |All | 68 * 69 * @note Supported input tensor rank: up to 4 70 * 71 * @param[in] input The vectors containing all the tensors with the same shape to stack. Data types supported: All 72 * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions. 73 * Negative values wrap around 74 * @param[out] output Output tensor. Data types supported: Same as @p input. 75 */ 76 void configure(const std::vector<ITensor *> &input, int axis, ITensor *output); 77 /** Static function to check if given info will lead to a valid configuration of @ref NEStackLayerKernel 78 * 79 * @note Supported input tensor rank: up to 4 80 * 81 * @param[in] input The vectors containing all the tensors info with the same shape to stack. Data types supported: All 82 * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions. 83 * Negative values wrap around 84 * @param[in] output Output tensor info. Data types supported: Same as @p input. 85 * 86 * @return a status 87 */ 88 static Status validate(const std::vector<ITensorInfo *> &input, int axis, const ITensorInfo *output); 89 90 // Inherited methods overridden: 91 void run() override; 92 93 private: 94 std::vector<ITensor *> _input; 95 std::vector<std::unique_ptr<NEStackLayerKernel>> _stack_kernels; 96 unsigned int _num_inputs; 97 }; 98 } // namespace arm_compute 99 #endif /* ARM_COMPUTE_NESTACKLAYER_H */ 100