xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLTileKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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 #ifndef ARM_COMPUTE_CLTILEKERNEL_H
25 #define ARM_COMPUTE_CLTILEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** OpenCL kernel to perform a Tile operation */
34 class CLTileKernel : public ICLKernel
35 {
36 public:
37     /** Default constructor */
38     CLTileKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     CLTileKernel(const CLTileKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLTileKernel &operator=(const CLTileKernel &) = delete;
43     /** Allow instances of this class to be moved */
44     CLTileKernel(CLTileKernel &&) = default;
45     /** Allow instances of this class to be moved */
46     CLTileKernel &operator=(CLTileKernel &&) = default;
47     /** Default destructor */
48     ~CLTileKernel() = default;
49     /** Set the source, destination of the kernel
50      *
51      * @param[in]  input     Source tensor. Data type supported: All.
52      * @param[in]  multiples Contains the number of times the input tensor should be replicated on the given dimension.
53      *                       Cannot have more than 4 elements (tiling in dimensions greater than 4 is not supported).
54      * @param[out] output    Destination tensor. Same as @p input
55      *
56      */
57     void configure(const ICLTensor *input, ICLTensor *output, const Multiples &multiples);
58     /** Set the source, destination of the kernel
59      *
60      * @param[in]  compile_context The compile context to be used.
61      * @param[in]  input           Source tensor. Data type supported: All.
62      * @param[in]  multiples       Contains the number of times the input tensor should be replicated on the given dimension.
63      *                             Cannot have more than 4 elements (tiling in dimensions greater than 4 is not supported).
64      * @param[out] output          Destination tensor. Same as @p input
65      *
66      */
67     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const Multiples &multiples);
68     /** Static function to check if given info will lead to a valid configuration of @ref CLTileKernel
69      *
70      * @param[in] input     Source tensor info. Data type supported: All.
71      * @param[in] multiples Contains the number of times the input tensor should be replicated on the given dimension.
72      *                      Cannot have more than 4 elements (tiling in dimensions greater than 4 is not supported).
73      * @param[in] output    Destination tensor info. Same as @p input
74      *
75      *
76      * @return a status
77      */
78     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Multiples &multiples);
79 
80     // Inherited methods overridden:
81     void run(const Window &window, cl::CommandQueue &queue) override;
82 
83 private:
84     const ICLTensor *_input;
85     ICLTensor       *_output;
86 };
87 } // namespace arm_compute
88 #endif /*ARM_COMPUTE_CLTILEKERNEL_H */
89