Compute Library
 21.05
NEFFTScaleKernel.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_NEFFTSCALEKERNEL_H
25 #define ARM_COMPUTE_NEFFTSCALEKERNEL_H
26 
28 
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ITensor;
35 
36 /** Interface for the inverse fft scale kernel. */
38 {
39 public:
40  const char *name() const override
41  {
42  return "NEFFTScaleKernel";
43  }
44  /** Constructor */
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  NEFFTScaleKernel(const NEFFTScaleKernel &) = delete;
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  NEFFTScaleKernel &operator=(const NEFFTScaleKernel &) = delete;
50  /** Default Move Constructor. */
51  NEFFTScaleKernel(NEFFTScaleKernel &&) = default;
52  /** Default move assignment operator */
54  /** Default destructor */
55  ~NEFFTScaleKernel() = default;
56  /** Set the input and output tensors.
57  *
58  * @param[in,out] input Source tensor. Data types supported: F32. Number of channels supported: 2 (complex tensor).
59  * @param[out] output Destination tensor. Data type supported: same as @p input. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
60  * @param[in] config Kernel configuration
61  */
62  void configure(ITensor *input, ITensor *output, const FFTScaleKernelInfo &config);
63  /** Static function to check if given info will lead to a valid configuration of @ref NEFFTScaleKernel
64  *
65  * @param[in] input Source tensor info. Data types supported: F32. Number of channels supported: 2 (complex tensor).
66  * @param[in] output Destination tensor info. Data type supported: same as @p input. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
67  * @param[in] config Kernel configuration
68  *
69  * @return a status
70  */
71  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTScaleKernelInfo &config);
72 
73  // Inherited methods overridden:
74  void run(const Window &window, const ThreadInfo &info) override;
75 
76 private:
77  ITensor *_input;
78  ITensor *_output;
79  float _scale;
80  bool _run_in_place;
81  bool _is_conj;
82 };
83 } // namespace arm_compute
84 #endif /*ARM_COMPUTE_NEFFTSCALEKERNEL_H */
~NEFFTScaleKernel()=default
Default destructor.
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
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTScaleKernelInfo &config)
Static function to check if given info will lead to a valid configuration of NEFFTScaleKernel.
Interface for the inverse fft scale kernel.
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.
NEFFTScaleKernel & operator=(const NEFFTScaleKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
const char * name() const override
Name of the kernel.
Descriptor for FFT scale kernels.
void configure(ITensor *input, ITensor *output, const FFTScaleKernelInfo &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:252
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
Describe a multidimensional execution window.
Definition: Window.h:39