blob: 9b36518e4db42e529f3d5a9f4c8951c366371c81 [file] [log] [blame]
Isabella Gottardiee7c15d2018-12-17 16:15:34 +00001/*
Sheri Zhangac6499a2021-02-10 15:32:38 +00002 * Copyright (c) 2018-2021 Arm Limited.
Isabella Gottardiee7c15d2018-12-17 16:15:34 +00003 *
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 Spyrouf4643372019-11-29 16:17:13 +000025#ifndef ARM_COMPUTE_NESTACKLAYERKERNEL_H
26#define ARM_COMPUTE_NESTACKLAYERKERNEL_H
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000027
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000028#include "arm_compute/core/Types.h"
Michalis Spyrouebcebf12020-10-21 00:04:14 +010029#include "src/core/NEON/INEKernel.h"
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000030
31namespace arm_compute
32{
33class ITensor;
34
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +000035/** Basic kernel to stack a rank-R tensor into one with rank-(R+1) along the axis dimension. */
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000036class NEStackLayerKernel : public INEKernel
37{
38public:
39 const char *name() const override
40 {
41 return "NEStackLayerKernel";
42 }
43 /** Default constructor */
44 NEStackLayerKernel();
45 /** Prevent instances of this class from being copied (As this class contains pointers) */
46 NEStackLayerKernel(const NEStackLayerKernel &) = delete;
47 /** Prevent instances of this class from being copied (As this class contains pointers) */
48 NEStackLayerKernel &operator=(const NEStackLayerKernel &) = delete;
49 /** Allow instances of this class to be moved */
50 NEStackLayerKernel(NEStackLayerKernel &&) = default;
51 /** Allow instances of this class to be moved */
52 NEStackLayerKernel &operator=(NEStackLayerKernel &&) = default;
53 /** Default destructor */
54 ~NEStackLayerKernel() = default;
55 /** Initialise the kernel's inputs and output
56 *
57 * @note Supported input tensor rank: up to 4
58 *
Georgios Pinitas33843562019-12-10 13:33:18 +000059 * @param[in] input Input tensor. Data types supported: All
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000060 * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
61 * @param[in] idx_input Index of the input tensor in the list of tensors to stack.
62 * All tensors in the list must have the same shape
63 * @param[in] num_tensors Number of tensors to stack
64 * @param[out] output Output tensor. Data types supported: Same as @p input.
65 *
66 */
67 void configure(const ITensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ITensor *output);
68 /** Static function to check if given info will lead to a valid configuration of @ref NEStackLayerKernel
69 *
70 * @note Supported input tensor rank: up to 4
71 *
Georgios Pinitas33843562019-12-10 13:33:18 +000072 * @param[in] input Input tensor info. Data types supported: All
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000073 * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
74 * @param[in] idx_input Index of the input tensor in the list of tensors to stack
75 * All tensors in the list must have the same shape
76 * @param[in] num_tensors Number of tensors to stack
77 * @param[in] output Output tensor info. Data types supported: Same as @p input.
78 *
79 * @return a status
80 */
81 static Status validate(const ITensorInfo *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, const ITensorInfo *output);
82
83 // Inherited methods overridden
84 void run(const Window &window, const ThreadInfo &info) override;
85
86private:
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000087 const ITensor *_input;
88 ITensor *_output;
89 unsigned int _axis;
90 unsigned int _idx_input;
Isabella Gottardiee7c15d2018-12-17 16:15:34 +000091};
92} // namespace arm_compute
Michalis Spyrouf4643372019-11-29 16:17:13 +000093#endif /* ARM_COMPUTE_NESTACKLAYERKERNEL_H */