Compute Library
 21.02
NEConcatenateLayer.h
Go to the documentation of this file.
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 
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 */
42 {
43 public:
44  /** Default constructor */
46  /** Destructor */
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  NEConcatenateLayer(const NEConcatenateLayer &) = delete;
50  /** Default move constructor */
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
54  /** Default move assignment operator */
56  /** Initialise the kernel's inputs vector and output.
57  *
58  * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis.
59  * @note Preconditions can be found respectively at @ref cpu::kernels::CpuConcatenateWidthKernel, @ref cpu::kernels::CpuConcatenateHeightKernel,
60  * @ref cpu::kernels::CpuConcatenateDepthKernel and @ref cpu::kernels::CpuConcatenateBatchKernel.
61  *
62  * @param[in,out] inputs_vector The vectors containing all the tensors to concatenate. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
63  * @param[out] output Output tensor. Data types supported: Same as @p input.
64  * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3.
65  */
66  void configure(std::vector<const ITensor *> inputs_vector, ITensor *output, size_t axis);
67  /** Static function to check if given info will lead to a valid configuration of @ref NEConcatenateLayer
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] inputs_vector The vectors containing all the tensors info to concatenate. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
74  * @param[in] output Output tensor info. 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  * @return a status
78  */
79  static Status validate(const std::vector<const ITensorInfo *> &inputs_vector, const ITensorInfo *output, size_t axis);
80 
81  // Inherited methods overridden:
82  void run() override;
83 
84 private:
85  struct Impl;
86  std::unique_ptr<Impl> _impl;
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NECONCATENATELAYER_H */
void run() override
Run the kernels contained in the function.
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic function to execute concatenate tensors along a given axis.
static Status validate(const std::vector< const ITensorInfo *> &inputs_vector, const ITensorInfo *output, size_t axis)
Static function to check if given info will lead to a valid configuration of NEConcatenateLayer.
NEConcatenateLayer & operator=(const NEConcatenateLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void configure(std::vector< const ITensor *> inputs_vector, ITensor *output, size_t axis)
Initialise the kernel&#39;s inputs vector and output.
NEConcatenateLayer()
Default constructor.