Compute Library
 22.08
CLFFT1D.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_CLFFT1D_H
25 #define ARM_COMPUTE_CLFFT1D_H
26 
28 
32 
33 namespace arm_compute
34 {
35 // Forward declaration
36 class CLFFTDigitReverseKernel;
37 class CLFFTRadixStageKernel;
38 class CLFFTScaleKernel;
39 class ICLTensor;
40 
41 /** Basic function to execute one dimensional FFT. This function calls the following OpenCL kernels:
42  *
43  * -# @ref CLFFTDigitReverseKernel Performs digit reverse.
44  * -# @ref CLFFTRadixStageKernel A list of FFT kernels depending on the radix decomposition.
45  * -# @ref CLFFTScaleKernel Performs output scaling in case of in inverse FFT.
46  */
47 class CLFFT1D : public IFunction
48 {
49 public:
50  /** Default Constructor */
51  CLFFT1D(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
52  /** Prevent instances of this class from being copied */
53  CLFFT1D(const CLFFT1D &) = delete;
54  /** Prevent instances of this class from being copied */
55  CLFFT1D &operator=(const CLFFT1D &) = delete;
56  /** Default move constructor */
57  CLFFT1D(CLFFT1D &&) = default;
58  /** Default move assignment operator */
59  CLFFT1D &operator=(CLFFT1D &&) = default;
60  /** Default destructor */
61  ~CLFFT1D();
62  /** Initialise the function's source, destinations and border mode.
63  *
64  * Valid data layouts:
65  * - All
66  *
67  * Valid data type configurations:
68  * |src |dst |
69  * |:------|:------|
70  * |F32 |F32 |
71  * |F16 |F16 |
72  *
73  * @param[in] input Source tensor. Data types supported: F16/F32.
74  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
75  * @param[in] config FFT related configuration
76  */
77  void configure(const ICLTensor *input, ICLTensor *output, const FFT1DInfo &config);
78  /** Initialise the function's source, destinations and border mode.
79  *
80  * @param[in] compile_context The compile context to be used.
81  * @param[in] input Source tensor. Data types supported: F16/F32.
82  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
83  * @param[in] config FFT related configuration
84  */
85  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const FFT1DInfo &config);
86  /** Static function to check if given info will lead to a valid configuration of @ref CLFFT1D.
87  *
88  * @param[in] input Source tensor info. Data types supported: F16/F32.
89  * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
90  * @param[in] config FFT related configuration
91  *
92  * @return a status
93  */
94  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT1DInfo &config);
95 
96  // Inherited methods overridden:
97  void run() override;
98 
99 protected:
100  MemoryGroup _memory_group;
101  std::unique_ptr<CLFFTDigitReverseKernel> _digit_reverse_kernel;
102  std::vector<std::unique_ptr<CLFFTRadixStageKernel>> _fft_kernels;
103  std::unique_ptr<CLFFTScaleKernel> _scale_kernel;
104  CLTensor _digit_reversed_input;
105  CLTensor _digit_reverse_indices;
106  unsigned int _num_ffts;
107  bool _run_scale;
108 };
109 } // namespace arm_compute
110 #endif /*ARM_COMPUTE_CLFFT1D_H */
Base class for all functions.
Definition: IFunction.h:30
void configure(const ICLTensor *input, ICLTensor *output, const FFT1DInfo &config)
Initialise the function&#39;s source, destinations and border mode.
Definition: CLFFT1D.cpp:52
Descriptor used by the FFT1D function.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT1DInfo &config)
Static function to check if given info will lead to a valid configuration of CLFFT1D.
Definition: CLFFT1D.cpp:121
~CLFFT1D()
Default destructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Basic function to execute one dimensional FFT.
Definition: CLFFT1D.h:47
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLFFT1D(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
Definition: CLFFT1D.cpp:38
CLFFT1D & operator=(const CLFFT1D &)=delete
Prevent instances of this class from being copied.
void run() override
Run the kernels contained in the function.
Definition: CLFFT1D.cpp:146
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41