Compute Library
 21.11
CLReverseKernel.h
Go to the documentation of this file.
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_CLREVERSEKERNEL_H
25 #define ARM_COMPUTE_CLREVERSEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the reverse kernel */
34 class CLReverseKernel : public ICLKernel
35 {
36 public:
37  /** Default constructor */
39  /** Prevent instances of this class from being copied (As this class contains pointers) */
40  CLReverseKernel(const CLReverseKernel &) = delete;
41  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  CLReverseKernel &operator=(const CLReverseKernel &) = delete;
43  /** Allow instances of this class to be moved */
44  CLReverseKernel(CLReverseKernel &&) = default;
45  /** Allow instances of this class to be moved */
47  /** Default destructor */
48  ~CLReverseKernel() = default;
49  /** Initialise the kernel's inputis and output
50  *
51  * @param[in] input Input tensor. Data types supported: All.
52  * @param[out] output Output tensor. Data type supported: Same as @p input
53  * @param[in] axis Axis tensor. Contains the indices of the dimensions to reverse. Data type supported: U32
54  */
55  void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *axis);
56  /** Initialise the kernel's inputis and output
57  *
58  * @param[in] compile_context The compile context to be used.
59  * @param[in] input Input tensor. Data types supported: All.
60  * @param[out] output Output tensor. Data type supported: Same as @p input
61  * @param[in] axis Axis tensor. Contains the indices of the dimensions to reverse. Data type supported: U32
62  */
63  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *axis);
64 
65  /** Static function to check if given info will lead to a valid configuration of @ref CLReverseKernel
66  *
67  * @param[in] input Input tensor info. Data types supported: All.
68  * @param[in] output Output tensor info. Data type supported: Same as @p input
69  * @param[in] axis Axis tensor info. Contains the indices of the dimensions to reverse. Data type supported: U32
70  *
71  * @return a status
72  */
73  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *axis);
74 
75  // Inherited methods overridden:
76  void run(const Window &window, cl::CommandQueue &queue) override;
77 
78 public:
79  const ICLTensor *_input;
81  const ICLTensor *_axis;
82 };
83 } // namespace arm_compute
84 #endif /*ARM_COMPUTE_CLREVERSEKERNEL_H */
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 *input, const ITensorInfo *output, const ITensorInfo *axis)
Static function to check if given info will lead to a valid configuration of CLReverseKernel.
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
Copyright (c) 2017-2021 Arm Limited.
CLReverseKernel & operator=(const CLReverseKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Interface for the reverse kernel.
void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *axis)
Initialise the kernel's inputis and output.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
~CLReverseKernel()=default
Default destructor.
CLReverseKernel()
Default constructor.
Describe a multidimensional execution window.
Definition: Window.h:39