Compute Library
 21.05
ClBatchConcatenateKernel.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_CL_BATCH_CONCATENATE_KERNEL_H
25 #define ARM_COMPUTE_CL_BATCH_CONCATENATE_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** Interface for the batch concatenate kernel.
38  * The src tensor will be concatenated into the destination tensor.
39  */
41 {
42 public:
43  /** Default constructor */
46  /** Initialise the kernel's source and destination
47  *
48  * @param[in] compile_context The compile context to be used.
49  * @param[in] src Source tensor info. Data types supported: All.
50  * @param[in] batch_offset The offset on axis # 3.
51  * @param[in,out] dst Destination tensor info. Data types supported: Same as @p src.
52  *
53  * @note: The dst tensor's low two dimensions can't be smaller than the src one's.
54  * @note: The gaps between the two lowest dimensions of src and dst need to be divisible by 2.
55  *
56  */
57  void configure(const CLCompileContext &compile_context, ITensorInfo *src, unsigned int batch_offset, ITensorInfo *dst);
58  /** Static function to check if given info will lead to a valid configuration of @ref ClBatchConcatenateKernel
59  *
60  * @param[in] src Input tensor info. Data types supported: All.
61  * @param[in] batch_offset The offset on axis # 3.
62  * @param[in] dst Destination tensor info. Data types supported: Same as @p src.
63  *
64  * @return a status
65  */
66  static Status validate(const ITensorInfo *src, unsigned int batch_offset, const ITensorInfo *dst);
67 
68  // Inherited methods overridden:
69  void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override;
70 
71 private:
72  unsigned int _batch_offset;
73 };
74 } // namespace kernels
75 } // namespace opencl
76 } // namespace arm_compute
77 #endif /* ARM_COMPUTE_CL_BATCH_CONCATENATE_KERNEL_H */
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClBatchConcatenateKernel)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor's metadata.
Definition: ITensorInfo.h:40
static Status validate(const ITensorInfo *src, unsigned int batch_offset, const ITensorInfo *dst)
Static function to check if given info will lead to a valid configuration of ClBatchConcatenateKernel...
void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
void configure(const CLCompileContext &compile_context, ITensorInfo *src, unsigned int batch_offset, ITensorInfo *dst)
Initialise the kernel's source and destination.
CLCompileContext class.
Tensor packing service.
Definition: ITensorPack.h:37
Describe a multidimensional execution window.
Definition: Window.h:39