• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_NEFFTRADIXSTAGEKERNEL_H
25 #define ARM_COMPUTE_NEFFTRADIXSTAGEKERNEL_H
26 
27 #include "arm_compute/core/KernelDescriptors.h"
28 #include "src/core/NEON/INEKernel.h"
29 
30 #include <arm_neon.h>
31 #include <set>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class ITensor;
37 
38 /** Interface for the FFT kernel. */
39 class NEFFTRadixStageKernel : public INEKernel
40 {
41 public:
name()42     const char *name() const override
43     {
44         return "NEFFTRadixStageKernel";
45     }
46     /** Constructor */
47     NEFFTRadixStageKernel();
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEFFTRadixStageKernel(const NEFFTRadixStageKernel &) = delete;
50     /** Prevent instances of this class from being copied (As this class contains pointers) */
51     NEFFTRadixStageKernel &operator=(const NEFFTRadixStageKernel &) = delete;
52     /** Default Move Constructor. */
53     NEFFTRadixStageKernel(NEFFTRadixStageKernel &&) = default;
54     /** Default move assignment operator */
55     NEFFTRadixStageKernel &operator=(NEFFTRadixStageKernel &&) = default;
56     /** Default destructor */
57     ~NEFFTRadixStageKernel() = default;
58     /** Set the input and output tensors.
59      *
60      * @note If the output tensor is nullptr, the FFT will be performed in-place
61      *
62      * @param[in,out] input  Source tensor. Data types supported: F32. Number of channels supported: 2 (complex tensor).
63      * @param[out]    output Destination tensor. Data type supported: same as @p input. Number of channels supported: same as @p input.
64      * @param[in]     config FFT descriptor metadata.
65      */
66     void configure(ITensor *input, ITensor *output, const FFTRadixStageKernelInfo &config);
67     /** Static function to check if given info will lead to a valid configuration of @ref NEFFTRadixStageKernel
68      *
69      * @param[in] input  Source tensor info. Data types supported: F32. Number of channels supported: 2 (complex tensor).
70      * @param[in] output Destination tensor info. Data type supported: same as @p input. Number of channels supported: same as @p input.
71      * @param[in] config FFT descriptor metadata.
72      *
73      * @return a status
74      */
75     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTRadixStageKernelInfo &config);
76     /** Returns the radix that are support by the FFT kernel
77      *
78      * @return A set of supported radix
79      */
80     static std::set<unsigned int> supported_radix();
81 
82     // Inherited methods overridden:
83     void run(const Window &window, const ThreadInfo &info) override;
84 
85 private:
86     ITensor     *_input;
87     ITensor     *_output;
88     unsigned int _Nx;
89     unsigned int _axis;
90     unsigned int _radix;
91 
92     void set_radix_stage_axis0(const FFTRadixStageKernelInfo &config);
93     void set_radix_stage_axis1(const FFTRadixStageKernelInfo &config);
94 
95     using FFTFunctionPointerAxis0 = std::function<void(float *, float *, unsigned int, unsigned int, const float32x2_t &, unsigned int)>;
96     using FFTFunctionPointerAxis1 = std::function<void(float *, float *, unsigned int, unsigned int, const float32x2_t &, unsigned int, unsigned int, unsigned int, unsigned int)>;
97 
98     FFTFunctionPointerAxis0 _func_0;
99     FFTFunctionPointerAxis1 _func_1;
100 };
101 } // namespace arm_compute
102 #endif /*ARM_COMPUTE_NEFFTRADIXSTAGEKERNEL_H */
103