Compute Library
 19.08
CLFFTScaleKernel Class Reference

Interface for the inverse fft scale kernel. More...

#include <CLFFTScaleKernel.h>

Collaboration diagram for CLFFTScaleKernel:
[legend]

Public Member Functions

 CLFFTScaleKernel ()
 Constructor. More...
 
 CLFFTScaleKernel (const CLFFTScaleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLFFTScaleKerneloperator= (const CLFFTScaleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLFFTScaleKernel (CLFFTScaleKernel &&)=default
 Default Move Constructor. More...
 
CLFFTScaleKerneloperator= (CLFFTScaleKernel &&)=default
 Default move assignment operator. More...
 
 ~CLFFTScaleKernel ()=default
 Default destructor. More...
 
void configure (ICLTensor *input, ICLTensor *output, const FFTScaleKernelInfo &config)
 Set the input and output tensors. More...
 
void run (const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_2D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Static Public Member Functions

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 CLFFTScaleKernel. More...
 
- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for the inverse fft scale kernel.

Definition at line 37 of file CLFFTScaleKernel.h.

Constructor & Destructor Documentation

◆ CLFFTScaleKernel() [1/3]

Constructor.

Definition at line 73 of file CLFFTScaleKernel.cpp.

74  : _input(nullptr), _output(nullptr), _run_in_place(false)
75 {
76 }

◆ CLFFTScaleKernel() [2/3]

CLFFTScaleKernel ( const CLFFTScaleKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLFFTScaleKernel() [3/3]

Default Move Constructor.

◆ ~CLFFTScaleKernel()

~CLFFTScaleKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( ICLTensor input,
ICLTensor output,
const FFTScaleKernelInfo config 
)

Set the input and output tensors.

Parameters
[in,out]inputSource tensor. Data types supported: F32.
[out]outputDestination tensor. Data type supported: same as input
[in]configKernel configuration

Definition at line 78 of file CLFFTScaleKernel.cpp.

79 {
81  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), (output != nullptr) ? output->info() : nullptr));
82 
83  _input = input;
84  _output = output;
85  _run_in_place = (output == nullptr) || (output == input);
86 
87  // Create kernel
88  CLBuildOptions build_opts;
89  build_opts.add_option_if(_run_in_place, "-DIN_PLACE");
90  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(output != nullptr ? output->info()->num_channels() : input->info()->num_channels()));
91  build_opts.add_option_if(config.conjugate, "-DCONJ");
92  std::string kernel_name = "fft_scale_conj";
93  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
94 
95  // Set static arguments
96  unsigned int idx = (1 + (_run_in_place ? 0 : 1)) * num_arguments_per_3D_tensor(); // Skip the input and output parameters
97  _kernel.setArg<cl_float>(idx, config.scale);
98 
99  // Configure kernel window
100  auto win_config = validate_and_configure_window(input->info(), _run_in_place ? nullptr : output->info());
101  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
102  ICLKernel::configure_internal(win_config.second);
103 
104  // Set config_id for enabling LWS tuning
105  _config_id = kernel_name;
106  _config_id += "_";
107  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
108  _config_id += "_";
109  _config_id += support::cpp11::to_string(input->info()->dimension(0));
110  _config_id += "_";
111  _config_id += support::cpp11::to_string(input->info()->dimension(1));
112 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
std::string to_string(T &&value)
Convert integer and float values to string.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
static constexpr unsigned int num_arguments_per_3D_tensor()
Returns the number of arguments enqueued per 3D tensor object.
Definition: ICLKernel.h:200
std::unique_ptr< Kernel > create_kernel()
Helper function to create and return a unique_ptr pointed to a CL/GLES kernel object.
Definition: Helpers.h:86
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, FFTScaleKernelInfo::conjugate, arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), arm_compute::lower_string(), ICLKernel::num_arguments_per_3D_tensor(), ITensorInfo::num_channels(), CLBuildOptions::options(), FFTScaleKernelInfo::scale, arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), and arm_compute::validate_and_configure_window().

Referenced by CLFFT1D::configure().

◆ operator=() [1/2]

CLFFTScaleKernel& operator= ( const CLFFTScaleKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

CLFFTScaleKernel& operator= ( CLFFTScaleKernel &&  )
default

Default move assignment operator.

◆ run()

void run ( const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Implements ICLKernel.

Definition at line 123 of file CLFFTScaleKernel.cpp.

124 {
127 
129  Window slice = collapsed.first_slice_window_3D();
130 
131  do
132  {
133  unsigned int idx = 0;
134  add_3D_tensor_argument(idx, _input, slice);
135  if(!_run_in_place)
136  {
137  add_3D_tensor_argument(idx, _output, slice);
138  }
139  enqueue(queue, *this, slice, lws_hint());
140  }
141  while(collapsed.slide_window_slice_3D(slice));
142 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
Definition: ICLKernel.cpp:39
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:247
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.
Definition: ICLKernel.h:158
Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed=nullptr) const
Collapse the dimensions between first and last if possible.
Definition: Window.inl:54
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const FFTScaleKernelInfo config 
)
static

Static function to check if given info will lead to a valid configuration of CLFFTScaleKernel.

Parameters
[in]inputSource tensor info. Data types supported: F32.
[in]outputDestination tensor info. Data type supported: same as input
[in]configKernel configuration
Returns
a status

Definition at line 114 of file CLFFTScaleKernel.cpp.

115 {
116  ARM_COMPUTE_UNUSED(config);
117  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output));
118  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get()).first);
119 
120  return Status{};
121 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:193
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:160

References ARM_COMPUTE_RETURN_ON_ERROR, ARM_COMPUTE_UNUSED, ICloneable< T >::clone(), and arm_compute::validate_and_configure_window().


The documentation for this class was generated from the following files: