Compute Library
 21.05
NEFFT2D.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_NEFFT2D_H
25 #define ARM_COMPUTE_NEFFT2D_H
26 
28 
33 
34 namespace arm_compute
35 {
36 // Forward declaration
37 class ITensor;
38 
39 /** Basic function to execute two dimensional FFT. This function calls the following kernels:
40  *
41  * -# @ref NEFFT1D 1D FFT is performed on the first given axis
42  * -# @ref NEFFT1D 1D FFT is performed on the second given axis
43  */
44 class NEFFT2D : public IFunction
45 {
46 public:
47  /** Default Constructor */
48  NEFFT2D(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  NEFFT2D(const NEFFT2D &) = delete;
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  NEFFT2D &operator=(const NEFFT2D &) = delete;
53  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
54  NEFFT2D(NEFFT2D &&) = delete;
55  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
56  NEFFT2D &operator=(NEFFT2D &&) = delete;
57  /** Default destructor */
58  ~NEFFT2D();
59  /** Initialise the function's source and destinations
60  *
61  * Valid data layouts:
62  * - All
63  *
64  * Valid data type configurations:
65  * |src |dst |
66  * |:------|:------|
67  * |F32 |F32 |
68  *
69  * @param[in] input Source tensor. Data types supported: F32.
70  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
71  * @param[in] config FFT related configuration
72  */
73  void configure(const ITensor *input, ITensor *output, const FFT2DInfo &config);
74  /** Static function to check if given info will lead to a valid configuration of @ref NEFFT2D.
75  *
76  * @param[in] input Source tensor info. Data types supported: F32.
77  * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
78  * @param[in] config FFT related configuration
79  *
80  * @return a status
81  */
82  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config);
83 
84  // Inherited methods overridden:
85  void run() override;
86 
87 protected:
88  MemoryGroup _memory_group;
89  NEFFT1D _first_pass_func;
90  NEFFT1D _second_pass_func;
91  Tensor _first_pass_tensor;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_NEFFT2D_H */
Base class for all functions.
Definition: IFunction.h:30
NEFFT2D(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
Definition: NEFFT2D.cpp:37
Descriptor used by the FFT2D function.
Basic function to execute one dimensional FFT.
Definition: NEFFT1D.h:49
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
NEFFT2D & operator=(const NEFFT2D &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
Basic function to execute two dimensional FFT.
Definition: NEFFT2D.h:44
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config)
Static function to check if given info will lead to a valid configuration of NEFFT2D.
Definition: NEFFT2D.cpp:62
Basic implementation of the tensor interface.
Definition: Tensor.h:37
void run() override
Run the kernels contained in the function.
Definition: NEFFT2D.cpp:91
~NEFFT2D()
Default destructor.
void configure(const ITensor *input, ITensor *output, const FFT2DInfo &config)
Initialise the function's source and destinations.
Definition: NEFFT2D.cpp:42