Compute Library
 21.05
CLFFT2D.cpp
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  */
25 
32 
33 namespace arm_compute
34 {
35 CLFFT2D::CLFFT2D(std::shared_ptr<IMemoryManager> memory_manager)
36  : _memory_group(memory_manager), _first_pass_func(memory_manager), _second_pass_func(memory_manager), _first_pass_tensor()
37 {
38 }
39 
40 CLFFT2D::~CLFFT2D() = default;
41 
42 void CLFFT2D::configure(const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config)
43 {
44  configure(CLKernelLibrary::get().get_compile_context(), input, output, config);
45 }
46 
47 void CLFFT2D::configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config)
48 {
50  ARM_COMPUTE_ERROR_THROW_ON(CLFFT2D::validate(input->info(), output->info(), config));
51 
52  // Setup first pass
53  FFT1DInfo first_pass_config;
54  first_pass_config.axis = config.axis0;
55  first_pass_config.direction = config.direction;
56  _memory_group.manage(&_first_pass_tensor);
57  _first_pass_func.configure(compile_context, input, &_first_pass_tensor, first_pass_config);
58 
59  // Setup second pass
60  FFT1DInfo second_pass_config;
61  second_pass_config.axis = config.axis1;
62  second_pass_config.direction = config.direction;
63  _second_pass_func.configure(compile_context, &_first_pass_tensor, output, second_pass_config);
64  _first_pass_tensor.allocator()->allocate();
65 }
66 
67 Status CLFFT2D::validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config)
68 {
71 
72  // Create intermediate tensor info
73  TensorInfo first_pass_tensor(input->clone()->set_is_resizable(true).reset_padding().set_num_channels(2));
74 
75  // Validate first pass
76  FFT1DInfo first_pass_config;
77  first_pass_config.axis = config.axis0;
78  first_pass_config.direction = config.direction;
79  ARM_COMPUTE_RETURN_ON_ERROR(CLFFT1D::validate(input, &first_pass_tensor, first_pass_config));
80 
81  // Validate second pass
82  FFT1DInfo second_pass_config;
83  second_pass_config.axis = config.axis1;
84  second_pass_config.direction = config.direction;
85  ARM_COMPUTE_RETURN_ON_ERROR(CLFFT1D::validate(&first_pass_tensor, output, second_pass_config));
86 
87  // Checks performed when output is configured
88  if((output != nullptr) && (output->total_size() != 0))
89  {
92  }
93 
94  return Status{};
95 }
96 
98 {
99  MemoryGroupResourceScope scope_mg(_memory_group);
100 
101  _first_pass_func.run();
102  _second_pass_func.run();
103 }
104 } // 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's source, destinations and border mode.
Definition: CLFFT2D.cpp:42
void configure(const ICLTensor *input, ICLTensor *output, const FFT1DInfo &config)
Initialise the function's source, destinations and border mode.
Definition: CLFFT1D.cpp:50
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:118
#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:97
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
CLTensorAllocator * allocator()
Return a pointer to the tensor'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 ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
CLFFT2D(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
Definition: CLFFT2D.cpp:35
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_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
Store the tensor'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:143
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:67