Compute Library
 22.11
CLFFTRadixStageKernel.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_CLFFTRADIXSTAGEKERNEL_H
25 #define ARM_COMPUTE_CLFFTRADIXSTAGEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
30 
31 #include <set>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class ICLTensor;
37 
38 /** Interface for the FFT radix stage kernel. */
40 {
41 public:
42  /** Constructor */
44  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  /** Default Move Constructor. */
50  /** Default move assignment operator */
52  /** Default destructor */
53  ~CLFFTRadixStageKernel() = default;
54  /** Set the input and output tensors.
55  *
56  * @note If the output tensor is nullptr, the FFT will be performed in-place
57  *
58  * @param[in,out] input Source tensor. Data types supported: F16/F32.
59  * @param[out] output Destination tensor. Can be nullptr. Data type supported: same as @p input
60  * @param[in] config FFT descriptor metadata.
61  */
62  void configure(ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config);
63  /** Set the input and output tensors.
64  *
65  * @note If the output tensor is nullptr, the FFT will be performed in-place
66  *
67  * @param[in] compile_context The compile context to be used.
68  * @param[in,out] input Source tensor. Data types supported: F16/F32.
69  * @param[out] output Destination tensor. Can be nullptr. Data type supported: same as @p input
70  * @param[in] config FFT descriptor metadata.
71  */
72  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config);
73  /** Static function to check if given info will lead to a valid configuration of @ref CLFFTRadixStageKernel
74  *
75  * @param[in] input Source tensor info. Data types supported: F16/F32.
76  * @param[in] output Destination tensor info. Can be nullptr. Data type supported: same as @p input
77  * @param[in] config FFT descriptor metadata.
78  *
79  * @return a status
80  */
81  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTRadixStageKernelInfo &config);
82  /** Returns the radix that are support by the FFT kernel
83  *
84  * @return A set of supported radix
85  */
86  static std::set<unsigned int> supported_radix();
87 
88  // Inherited methods overridden:
89  void run(const Window &window, cl::CommandQueue &queue) override;
90 
91 private:
92  ICLTensor *_input;
93  ICLTensor *_output;
94  bool _run_in_place;
95 };
96 } // namespace arm_compute
97 #endif /*ARM_COMPUTE_CLFFTRADIXSTAGEKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
~CLFFTRadixStageKernel()=default
Default destructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
void configure(ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config)
Set the input and output tensors.
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:80
Interface for the FFT radix stage kernel.
Copyright (c) 2017-2022 Arm Limited.
CLFFTRadixStageKernel & operator=(const CLFFTRadixStageKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Descriptor used by the FFT core kernels.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTRadixStageKernelInfo &config)
Static function to check if given info will lead to a valid configuration of CLFFTRadixStageKernel.
CLCompileContext class.
static std::set< unsigned int > supported_radix()
Returns the radix that are support by the FFT kernel.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Describe a multidimensional execution window.
Definition: Window.h:39