xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuConcatenateBatchKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-2022 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_CPU_CONCATENATE_BATCH_KERNEL_H
25 #define ARM_COMPUTE_CPU_CONCATENATE_BATCH_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
28 #include "src/cpu/ICpuKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the batch concatenate kernel.
37  *  The input tensor will be concatenated into the output tensor.
38  */
39 class CpuConcatenateBatchKernel : public ICpuKernel<CpuConcatenateBatchKernel>
40 {
41 public:
42     CpuConcatenateBatchKernel() = default;
43     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuConcatenateBatchKernel);
44     /** Configure kernel for a given list of arguments
45      *
46      * @param[in]     src          Source tensor info. Data types supported: All.
47      * @param[in]     batch_offset The offset on axis # 3.
48      * @param[in,out] dst          Destination tensor info. Data types supported: Same as @p src.
49      */
50     void configure(const ITensorInfo *src, unsigned int batch_offset, ITensorInfo *dst);
51     /** Static function to check if given info will lead to a valid configuration
52      *
53      * Similar to @ref CpuConcatenateBatchKernel::configure()
54      *
55      * @return a status
56      */
57     static Status validate(const ITensorInfo *src, unsigned int batch_offset, const ITensorInfo *dst);
58 
59     // Inherited methods overridden:
60     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
61     const char *name() const override;
62 
63 private:
64     using BatchConcatFunction = void(const ITensor *, ITensor *, unsigned int, const Window &);
65 
66 private:
67     BatchConcatFunction *_func{ nullptr };
68     unsigned int         _batch_offset{ 0 };
69 };
70 } // namespace kernels
71 } // namespace cpu
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CPU_CONCATENATE_BATCH_KERNEL_H */
74