xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLFFTScaleKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_CLFFTSCALEKERNEL_H
25 #define ARM_COMPUTE_CLFFTSCALEKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 #include "arm_compute/core/KernelDescriptors.h"
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ICLTensor;
35 
36 /** Interface for the inverse fft scale kernel. */
37 class CLFFTScaleKernel : public ICLKernel
38 {
39 public:
40     /** Constructor */
41     CLFFTScaleKernel();
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     CLFFTScaleKernel(const CLFFTScaleKernel &) = delete;
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     CLFFTScaleKernel &operator=(const CLFFTScaleKernel &) = delete;
46     /** Default Move Constructor. */
47     CLFFTScaleKernel(CLFFTScaleKernel &&) = default;
48     /** Default move assignment operator */
49     CLFFTScaleKernel &operator=(CLFFTScaleKernel &&) = default;
50     /** Default destructor */
51     ~CLFFTScaleKernel() = default;
52     /** Set the input and output tensors.
53      *
54      * @param[in,out] input  Source tensor. Data types supported: F16/F32.
55      * @param[out]    output Destination tensor. Data type supported: same as @p input
56      * @param[in]     config Kernel configuration
57      */
58     void configure(ICLTensor *input, ICLTensor *output, const FFTScaleKernelInfo &config);
59     /** Set the input and output tensors.
60      *
61      * @param[in]     compile_context The compile context to be used.
62      * @param[in,out] input           Source tensor. Data types supported: F16/F32.
63      * @param[out]    output          Destination tensor. Data type supported: same as @p input
64      * @param[in]     config          Kernel configuration
65      */
66     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const FFTScaleKernelInfo &config);
67     /** Static function to check if given info will lead to a valid configuration of @ref CLFFTScaleKernel
68      *
69      * @param[in] input  Source tensor info. Data types supported: F16/F32.
70      * @param[in] output Destination tensor info. Data type supported: same as @p input
71      * @param[in] config Kernel configuration
72      *
73      * @return a status
74      */
75     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFTScaleKernelInfo &config);
76 
77     // Inherited methods overridden:
78     void run(const Window &window, cl::CommandQueue &queue) override;
79 
80 private:
81     ICLTensor *_input;
82     ICLTensor *_output;
83     bool       _run_in_place;
84 };
85 } // namespace arm_compute
86 #endif /*ARM_COMPUTE_CLFFTSCALEKERNEL_H */
87