Compute Library
 21.05
ClConcatenate.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_CLCONCATENATE_H
25 #define ARM_COMPUTE_CLCONCATENATE_H
26 
30 
31 #include <vector>
32 
33 namespace arm_compute
34 {
35 namespace opencl
36 {
37 /** Basic function to execute concatenate tensors along a given axis. This function calls the following kernels:
38  *
39  * -# @ref kernels::ClWidthConcatenateKernel (if underlying concatenation axis is 0).
40  * -# @ref kernels::ClHeightConcatenateKernel (if underlying concatenation axis is 1).
41  * -# @ref kernels::ClDepthConcatenateKernel (if underlying concatenation axis is 2).
42  * -# @ref kernels::ClBatchConcatenateKernel (if underlying concatenation axis is 3).
43  */
44 class ClConcatenate : public IClOperator
45 {
46 public:
47  /** Default constructor */
48  ClConcatenate();
49  /** Initialise the kernel's inputs vector and dst.
50  *
51  * @note Input and dst tensor dimensions preconditions defer depending on the concatenation axis.
52  * @note Preconditions can be found respectively at @ref kernels::ClWidthConcatenateKernel,
53  * @ref kernels::ClHeightConcatenateKernel and @ref kernels::ClDepthConcatenateKernel.
54  *
55  *
56  * @param[in] compile_context The compile context to be used.
57  * @param[in,out] src_vector The vectors containing all the tensors info to concatenate. Data types supported: All
58  * @param[out] dst Destination tensor info. Data types supported: same as @p src_vector.
59  * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3.
60  */
61  void configure(const ClCompileContext &compile_context, const std::vector<ITensorInfo *> &src_vector, ITensorInfo *dst, size_t axis);
62  /** Static function to check if given info will lead to a valid configuration of @ref ClConcatenate
63  *
64  * @note Input and dst tensor dimensions preconditions defer depending on the concatenation axis.
65  * @note Preconditions can be found respectively at @ref kernels::ClWidthConcatenateKernel,
66  * @ref kernels::ClHeightConcatenateKernel and @ref kernels::ClDepthConcatenateKernel.
67  *
68  * @param[in] src_vector The vectors containing all the tensors info to concatenate. Data types supported: All
69  * @param[in] dst Destination tensor info. Data types supported: same as @p src_vector.
70  * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3.
71  *
72  * @return a status
73  */
74  static Status validate(const std::vector<const ITensorInfo *> &src_vector, const ITensorInfo *dst, size_t axis);
75 
76  // Inherited methods overridden:
77  void run(ITensorPack &tensors) override;
78 
79 private:
80  std::vector<std::unique_ptr<IClKernel>> _concat_kernels;
81  unsigned int _num_inputs;
82  unsigned int _axis;
83 };
84 } // namespace opencl
85 } // namespace arm_comPUTE
86 #endif /* ARM_COMPUTE_CL_CONCATENATE_H */
ClConcatenate()
Default constructor.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2021 Arm Limited.
void run(ITensorPack &tensors) override
Run the kernels contained in the function.
CLCompileContext class.
Tensor packing service.
Definition: ITensorPack.h:37
void configure(const ClCompileContext &compile_context, const std::vector< ITensorInfo * > &src_vector, ITensorInfo *dst, size_t axis)
Initialise the kernel's inputs vector and dst.
Basic function to execute concatenate tensors along a given axis.
Definition: ClConcatenate.h:44
static Status validate(const std::vector< const ITensorInfo * > &src_vector, const ITensorInfo *dst, size_t axis)
Static function to check if given info will lead to a valid configuration of ClConcatenate.
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41