• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2019-2020 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 
25 #ifndef ARM_COMPUTE_NEBATCHCONCATENATEKERNEL_H
26 #define ARM_COMPUTE_NEBATCHCONCATENATEKERNEL_H
27 
28 #include "src/core/NEON/INEKernel.h"
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ITensor;
34 
35 /** Interface for the batch concatenate kernel.
36  *  The input tensor will be concatenated into the output tensor.
37  */
38 class NEBatchConcatenateLayerKernel : public INEKernel
39 {
40 public:
name()41     const char *name() const override
42     {
43         return "NEBatchConcatenateLayerKernel";
44     }
45     /** Default constructor */
46     NEBatchConcatenateLayerKernel();
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NEBatchConcatenateLayerKernel(const NEBatchConcatenateLayerKernel &) = delete;
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEBatchConcatenateLayerKernel &operator=(const NEBatchConcatenateLayerKernel &) = delete;
51     /** Allow instances of this class to be moved */
52     NEBatchConcatenateLayerKernel(NEBatchConcatenateLayerKernel &&) = default;
53     /** Allow instances of this class to be moved */
54     NEBatchConcatenateLayerKernel &operator=(NEBatchConcatenateLayerKernel &&) = default;
55     /** Default destructor */
56     ~NEBatchConcatenateLayerKernel() = default;
57     /** Initialise the kernel's inputs and output
58      *
59      * @param[in]     input        Input tensor info. Data types supported: All.
60      * @param[in]     batch_offset The offset on axis # 3.
61      * @param[in,out] output       Output tensor info. Data types supported: Same as @p input.
62      *
63      * @note: The output tensor's low two dimensions can't be smaller than the input one's.
64      * @note: The gaps between the two lowest dimensions of input and output need to be divisible by 2.
65      *
66      */
67     void configure(const ITensorInfo *input, unsigned int batch_offset, ITensorInfo *output);
68     /**  Static function to check if given info will lead to a valid configuration of @ref NEBatchConcatenateLayerKernel
69      *
70      * @param[in] input        Input tensor info. Data types supported: All.
71      * @param[in] batch_offset The offset on axis # 3.
72      * @param[in] output       Output tensor info. Data types supported: Same as @p input.
73      *
74      * @return a status
75      */
76     static Status validate(const ITensorInfo *input, unsigned int batch_offset, const ITensorInfo *output);
77 
78     // Inherited methods overridden:
79     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
80 
81 private:
82     using BatchConcatFunction = void(const ITensor *in, ITensor *out, unsigned int batch_offset, const Window &window);
83 
84 private:
85     BatchConcatFunction *_func;
86     unsigned int         _batch_offset;
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NEBATCHCONCATENATEKERNEL_H */
90