Compute Library
 21.11
CLFFT2D.cpp
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  */
25 
32 
33 #include "src/common/utils/Log.h"
34 
35 namespace arm_compute
36 {
37 CLFFT2D::CLFFT2D(std::shared_ptr<IMemoryManager> memory_manager)
38  : _memory_group(memory_manager), _first_pass_func(memory_manager), _second_pass_func(memory_manager), _first_pass_tensor()
39 {
40 }
41 
42 CLFFT2D::~CLFFT2D() = default;
43 
44 void CLFFT2D::configure(const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config)
45 {
46  configure(CLKernelLibrary::get().get_compile_context(), input, output, config);
47 }
48 
49 void CLFFT2D::configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config)
50 {
51  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
52  ARM_COMPUTE_ERROR_THROW_ON(CLFFT2D::validate(input->info(), output->info(), config));
53  ARM_COMPUTE_LOG_PARAMS(input, output, config);
54 
55  // Setup first pass
56  FFT1DInfo first_pass_config;
57  first_pass_config.axis = config.axis0;
58  first_pass_config.direction = config.direction;
59  _memory_group.manage(&_first_pass_tensor);
60  _first_pass_func.configure(compile_context, input, &_first_pass_tensor, first_pass_config);
61 
62  // Setup second pass
63  FFT1DInfo second_pass_config;
64  second_pass_config.axis = config.axis1;
65  second_pass_config.direction = config.direction;
66  _second_pass_func.configure(compile_context, &_first_pass_tensor, output, second_pass_config);
67  _first_pass_tensor.allocator()->allocate();
68 }
69 
70 Status CLFFT2D::validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config)
71 {
74 
75  // Create intermediate tensor info
76  TensorInfo first_pass_tensor(input->clone()->set_is_resizable(true).reset_padding().set_num_channels(2));
77 
78  // Validate first pass
79  FFT1DInfo first_pass_config;
80  first_pass_config.axis = config.axis0;
81  first_pass_config.direction = config.direction;
82  ARM_COMPUTE_RETURN_ON_ERROR(CLFFT1D::validate(input, &first_pass_tensor, first_pass_config));
83 
84  // Validate second pass
85  FFT1DInfo second_pass_config;
86  second_pass_config.axis = config.axis1;
87  second_pass_config.direction = config.direction;
88  ARM_COMPUTE_RETURN_ON_ERROR(CLFFT1D::validate(&first_pass_tensor, output, second_pass_config));
89 
90  // Checks performed when output is configured
91  if((output != nullptr) && (output->total_size() != 0))
92  {
95  }
96 
97  return Status{};
98 }
99 
101 {
102  MemoryGroupResourceScope scope_mg(_memory_group);
103 
104  _first_pass_func.run();
105  _second_pass_func.run();
106 }
107 } // namespace arm_compute
unsigned int axis
Axis to run the FFT on.
FFTDirection direction
Direction of the FFT.
void configure(const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config)
Initialise the function&#39;s source, destinations and border mode.
Definition: CLFFT2D.cpp:44
void configure(const ICLTensor *input, ICLTensor *output, const FFT1DInfo &config)
Initialise the function&#39;s source, destinations and border mode.
Definition: CLFFT1D.cpp:52
Descriptor used by the FFT1D function.
Descriptor used by the FFT2D function.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT1DInfo &config)
Static function to check if given info will lead to a valid configuration of CLFFT1D.
Definition: CLFFT1D.cpp:121
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
1 channel, 1 F32 per channel
void run() override
Run the kernels contained in the function.
Definition: CLFFT2D.cpp:100
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
CLTensorAllocator * allocator()
Return a pointer to the tensor&#39;s allocator.
Definition: CLTensor.cpp:61
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Status class.
Definition: Error.h:52
Copyright (c) 2017-2021 Arm Limited.
1 channel, 1 F16 per channel
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
void manage(IMemoryManageable *obj) override
Sets a object to be managed by the given memory group.
Definition: MemoryGroup.h:79
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
~CLFFT2D()
Default destructor.
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
CLFFT2D(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
Definition: CLFFT2D.cpp:37
CLCompileContext class.
void allocate() override
Allocate size specified by TensorInfo of OpenCL memory.
Memory group resources scope handling class.
Definition: IMemoryGroup.h:82
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
virtual size_t total_size() const =0
Returns the total size of the tensor in bytes.
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(...)
Definition: Validate.h:439
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:541
unsigned int axis1
Axis to run second pass on.
#define ARM_COMPUTE_LOG_PARAMS(...)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
Store the tensor&#39;s metadata.
Definition: TensorInfo.h:43
FFTDirection direction
Direction of the FFT.
#define ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_NOT_IN(t,...)
Definition: Validate.h:690
void run() override
Run the kernels contained in the function.
Definition: CLFFT1D.cpp:146
unsigned int axis0
Axis to run first pass on.
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 CLFFT2D.
Definition: CLFFT2D.cpp:70