Compute Library
 21.11
CLFFTDigitReverseKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_CLFFTDIGITREVERSEKERNEL_H
25 #define ARM_COMPUTE_CLFFTDIGITREVERSEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ICLTensor;
35 
36 /** Interface for the digit reverse operation kernel. */
38 {
39 public:
40  /** Constructor */
42  /** Prevent instances of this class from being copied (As this class contains pointers) */
44  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  /** Default Move Constructor. */
48  /** Default move assignment operator */
50  /** Default destructor */
51  ~CLFFTDigitReverseKernel() = default;
52  /** Set the input and output tensors.
53  *
54  * @param[in] input Source tensor. Data types supported: F16/F32.
55  * @param[out] output Destination tensor. Data type supported: same as @p input
56  * @param[in] idx Digit reverse index tensor. Data type supported: U32
57  * @param[in] config Kernel configuration.
58  */
59  void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *idx, const FFTDigitReverseKernelInfo &config);
60  /** Set the input and output tensors.
61  *
62  * @param[in] compile_context The compile context to be used.
63  * @param[in] input Source tensor. Data types supported: F16/F32.
64  * @param[out] output Destination tensor. Data type supported: same as @p input
65  * @param[in] idx Digit reverse index tensor. Data type supported: U32
66  * @param[in] config Kernel configuration.
67  */
68  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *idx, const FFTDigitReverseKernelInfo &config);
69  /** Static function to check if given info will lead to a valid configuration of @ref CLFFTDigitReverseKernel
70  *
71  * @param[in] input Source tensor info. Data types supported: F16/F32.
72  * @param[in] output Destination tensor info. Data type supported: same as @p input
73  * @param[in] idx Digit reverse index tensor info. Data type supported: U32
74  * @param[in] config Kernel configuration.
75  *
76  * @return a status
77  */
78  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *idx, const FFTDigitReverseKernelInfo &config);
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  const ICLTensor *_idx;
87 };
88 } // namespace arm_compute
89 #endif /*ARM_COMPUTE_CLFFTDIGITREVERSEKERNEL_H */
~CLFFTDigitReverseKernel()=default
Default destructor.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *idx, const FFTDigitReverseKernelInfo &config)
Static function to check if given info will lead to a valid configuration of CLFFTDigitReverseKernel...
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
Copyright (c) 2017-2021 Arm Limited.
CLFFTDigitReverseKernel & operator=(const CLFFTDigitReverseKernel &)=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...
void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *idx, const FFTDigitReverseKernelInfo &config)
Set the input and output tensors.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Descriptor for FFT digit reverse kernels.
Describe a multidimensional execution window.
Definition: Window.h:39
Interface for the digit reverse operation kernel.