Compute Library
 22.05
NEFFTDigitReverseKernel.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_NEFFTDIGITREVERSEKERNEL_H
25 #define ARM_COMPUTE_NEFFTDIGITREVERSEKERNEL_H
26 
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ITensor;
34 
35 /** Interface for the digit reverse operation kernel. */
37 {
38 public:
39  const char *name() const override
40  {
41  return "NEFFTDigitReverseKernel";
42  }
43  /** Constructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  /** Default Move Constructor. */
51  /** Default move assignment operator */
53  /** Default destructor */
54  ~NEFFTDigitReverseKernel() = default;
55  /** Set the input and output tensors.
56  *
57  * @param[in] input Source tensor. Data types supported: F32. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
58  * @param[out] output Destination tensor. Data type supported: same as @p input. Number of channels supported: 2 (complex tensor).
59  * @param[in] idx Digit reverse index tensor. Data type supported: U32
60  * @param[in] config Kernel configuration.
61  */
62  void configure(const ITensor *input, ITensor *output, const ITensor *idx, const FFTDigitReverseKernelInfo &config);
63 
64  /** Static function to check if given info will lead to a valid configuration of @ref NEFFTDigitReverseKernel
65  *
66  * @param[in] input Source tensor info. Data types supported: F32. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
67  * @param[in] output Destination tensor info. Data type supported: same as @p input. Number of channels supported: 2 (complex tensor).
68  * @param[in] idx Digit reverse index tensor info. Data type supported: U32
69  * @param[in] config Kernel configuration
70  *
71  * @return a status
72  */
73  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *idx, const FFTDigitReverseKernelInfo &config);
74 
75  // Inherited methods overridden:
76  void run(const Window &window, const ThreadInfo &info) override;
77 
78 private:
79  using NEFFTDigitReverseKernelFunctionPtr = void (NEFFTDigitReverseKernel::*)(const Window &window);
80 
81  template <bool is_input_complex, bool is_conj>
82  void digit_reverse_kernel_axis_0(const Window &window);
83 
84  template <bool is_input_complex, bool is_conj>
85  void digit_reverse_kernel_axis_1(const Window &window);
86 
87  NEFFTDigitReverseKernelFunctionPtr _func;
88  const ITensor *_input;
89  ITensor *_output;
90  const ITensor *_idx;
91 };
92 } // namespace arm_compute
93 #endif /*ARM_COMPUTE_NEFFTDIGITREVERSEKERNEL_H */
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
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 NEFFTDigitReverseKernel...
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
Interface for the digit reverse operation kernel.
const char * name() const override
Name of the kernel.
void configure(const ITensor *input, ITensor *output, const ITensor *idx, const FFTDigitReverseKernelInfo &config)
Set the input and output tensors.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:169
NEFFTDigitReverseKernel & operator=(const NEFFTDigitReverseKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Descriptor for FFT digit reverse kernels.
~NEFFTDigitReverseKernel()=default
Default destructor.
Describe a multidimensional execution window.
Definition: Window.h:39