xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEConcatenateLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NECONCATENATELAYER_H
25 #define ARM_COMPUTE_NECONCATENATELAYER_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 // Forward declarations
36 class ITensor;
37 class ITensorInfo;
38 class Status;
39 
40 /** Basic function to execute concatenate tensors along a given axis */
41 class NEConcatenateLayer : public IFunction
42 {
43 public:
44     /** Default constructor */
45     NEConcatenateLayer();
46     /** Destructor */
47     ~NEConcatenateLayer();
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEConcatenateLayer(const NEConcatenateLayer &) = delete;
50     /** Default move constructor */
51     NEConcatenateLayer(NEConcatenateLayer &&);
52     /** Prevent instances of this class from being copied (As this class contains pointers) */
53     NEConcatenateLayer &operator=(const NEConcatenateLayer &) = delete;
54     /** Default move assignment operator */
55     NEConcatenateLayer &operator=(NEConcatenateLayer &&);
56     /** Initialise the kernel's inputs vector and output.
57      *
58      * Valid data layouts:
59      * - All
60      *
61      * Valid data type configurations:
62      * |src            |dst            |
63      * |:--------------|:--------------|
64      * |QASYMM8        |QASYMM8        |
65      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
66      * |F16            |F16            |
67      * |F32            |F32            |
68      *
69      * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis.
70      * @note Preconditions can be found respectively at @ref cpu::kernels::CpuConcatenateWidthKernel, @ref cpu::kernels::CpuConcatenateHeightKernel,
71      *       @ref cpu::kernels::CpuConcatenateDepthKernel and @ref cpu::kernels::CpuConcatenateBatchKernel.
72      *
73      * @param[in,out] inputs_vector The vectors containing all the tensors to concatenate. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
74      * @param[out]    output        Output tensor. Data types supported: Same as @p input.
75      * @param[in]     axis          Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3.
76      */
77     void configure(std::vector<const ITensor *> inputs_vector, ITensor *output, size_t axis);
78     /** Static function to check if given info will lead to a valid configuration of @ref NEConcatenateLayer
79      *
80      * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis.
81      * @note Preconditions can be found respectively at @ref cpu::kernels::CpuConcatenateWidthKernel, @ref cpu::kernels::CpuConcatenateHeightKernel,
82      *       @ref cpu::kernels::CpuConcatenateDepthKernel and @ref cpu::kernels::CpuConcatenateBatchKernel.
83      *
84      * @param[in] inputs_vector The vectors containing all the tensors info to concatenate. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
85      * @param[in] output        Output tensor info. Data types supported: Same as @p input.
86      * @param[in] axis          Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3.
87      *
88      * @return a status
89      */
90     static Status validate(const std::vector<const ITensorInfo *> &inputs_vector, const ITensorInfo *output, size_t axis);
91 
92     // Inherited methods overridden:
93     void run() override;
94 
95 private:
96     struct Impl;
97     std::unique_ptr<Impl> _impl;
98 };
99 } // namespace arm_compute
100 #endif /* ARM_COMPUTE_NECONCATENATELAYER_H */
101