Compute Library
 19.08
CLDerivativeKernel Class Reference

Interface for the derivative kernel. More...

#include <CLDerivativeKernel.h>

Collaboration diagram for CLDerivativeKernel:
[legend]

Public Member Functions

 CLDerivativeKernel ()
 Default constructor. More...
 
 CLDerivativeKernel (const CLDerivativeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLDerivativeKerneloperator= (const CLDerivativeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLDerivativeKernel (CLDerivativeKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLDerivativeKerneloperator= (CLDerivativeKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLDerivativeKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
 Initialise the kernel's sources, destination and border. 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...
 
BorderSize border_size () const override
 The size of the border for that kernel. 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...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Additional Inherited Members

- 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 derivative kernel.

Definition at line 34 of file CLDerivativeKernel.h.

Constructor & Destructor Documentation

◆ CLDerivativeKernel() [1/3]

Default constructor.

Definition at line 40 of file CLDerivativeKernel.cpp.

41  : _input(nullptr), _output_x(nullptr), _output_y(nullptr), _run_derivative_x(false), _run_derivative_y(false)
42 {
43 }

◆ CLDerivativeKernel() [2/3]

CLDerivativeKernel ( const CLDerivativeKernel )
delete

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

◆ CLDerivativeKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLDerivativeKernel()

~CLDerivativeKernel ( )
default

Default destructor.

Member Function Documentation

◆ border_size()

BorderSize border_size ( ) const
overridevirtual

The size of the border for that kernel.

Returns
The width in number of elements of the border.

Reimplemented from IKernel.

Definition at line 45 of file CLDerivativeKernel.cpp.

46 {
47  return BorderSize(1);
48 }
Container for 2D border size.
Definition: Types.h:259

Referenced by CLDerivativeKernel::configure().

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output_x,
ICLTensor output_y,
bool  border_undefined 
)

Initialise the kernel's sources, destination and border.

Note
At least one of output_x or output_y must be set
Parameters
[in]inputSource tensor. Data types supported: U8.
[out]output_x(Optional) Destination tensor for the X gradient, Data types supported: S16.
[out]output_y(Optional) Destination tensor for the Y gradient, Data types supported: S16.
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 50 of file CLDerivativeKernel.cpp.

51 {
53  ARM_COMPUTE_ERROR_ON((output_x == nullptr) && (output_y == nullptr));
54 
55  _run_derivative_x = output_x != nullptr;
56  _run_derivative_y = output_y != nullptr;
57 
58  if(_run_derivative_x)
59  {
61  }
62 
63  if(_run_derivative_y)
64  {
66  }
67 
68  _input = input;
69  _output_x = output_x;
70  _output_y = output_y;
71 
72  // Set build options
73  std::set<std::string> build_opts;
74 
75  if(_run_derivative_x)
76  {
77  build_opts.insert("-DGRAD_X");
78  }
79 
80  if(_run_derivative_y)
81  {
82  build_opts.insert("-DGRAD_Y");
83  }
84 
85  // Create kernel
86  const std::string kernel_name = std::string("derivative");
87  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts));
88 
89  // Configure kernel window
90  constexpr unsigned int num_elems_processed_per_iteration = 16;
91  constexpr unsigned int num_read_rows_per_iteration = 3;
92 
93  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
94 
95  AccessWindowRectangle input_access(input->info(), 0, 0, 0, 0);
96  AccessWindowHorizontal output_x_access(output_x == nullptr ? nullptr : output_x->info(), 0, num_elems_processed_per_iteration);
97  AccessWindowHorizontal output_y_access(output_y == nullptr ? nullptr : output_y->info(), 0, num_elems_processed_per_iteration);
98  if(_run_derivative_x && _run_derivative_y)
99  {
100  // TODO(COMPMID-415) Fix x-access input bug in CL kernel instead of '+2'
101  input_access = AccessWindowRectangle(input->info(), -border_size().left, -border_size().top, num_elems_processed_per_iteration + 2, num_read_rows_per_iteration);
102  }
103  else if(_run_derivative_x)
104  {
105  // TODO(COMPMID-415) Fix x-access input bug in CL kernel instead of '+2'
106  input_access = AccessWindowHorizontal(input->info(), -border_size().left, num_elems_processed_per_iteration + 2);
107  }
108  else if(_run_derivative_y)
109  {
110  input_access = AccessWindowRectangle(input->info(), 0, -border_size().top, num_elems_processed_per_iteration, num_read_rows_per_iteration);
111  }
112 
114  input_access,
115  output_x_access,
116  output_y_access);
117 
118  output_x_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
119  output_y_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
120 
121  ICLKernel::configure_internal(win);
122 
123  // Set config_id for enabling LWS tuning
124  _config_id = kernel_name;
125  _config_id += "_";
126  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
127  _config_id += "_";
128  _config_id += support::cpp11::to_string(input->info()->dimension(0));
129  _config_id += "_";
130  _config_id += support::cpp11::to_string(input->info()->dimension(1));
131  _config_id += "_";
132  _config_id += support::cpp11::to_string(border_undefined);
133 }
unsigned int top
top of the border
Definition: Types.h:339
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
1 channel, 1 U8 per channel
std::string to_string(T &&value)
Convert integer and float values to string.
virtual DataType data_type() const =0
Data type used for each element of the tensor.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:337
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
BorderSize border_size() const override
The size of the border for that kernel.
Implementation of a rectangular access pattern.
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: Helpers.h:402
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
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
unsigned int left
left of the border
Definition: Types.h:342
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
Describe a multidimensional execution window.
Definition: Window.h:39

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, CLDerivativeKernel::border_size(), arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), BorderSize::left, arm_compute::lower_string(), arm_compute::S16, arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), BorderSize::top, arm_compute::U8, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

◆ operator=() [1/2]

CLDerivativeKernel& operator= ( const CLDerivativeKernel )
delete

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

◆ operator=() [2/2]

CLDerivativeKernel& operator= ( CLDerivativeKernel &&  )
default

Allow instances of this class to be moved.

◆ 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 135 of file CLDerivativeKernel.cpp.

136 {
139 
141  do
142  {
143  unsigned int idx = 0;
144  add_2D_tensor_argument(idx, _input, slice);
145  add_2D_tensor_argument_if((_run_derivative_x), idx, _output_x, slice);
146  add_2D_tensor_argument_if((_run_derivative_y), idx, _output_y, slice);
147 
148  enqueue(queue, *this, slice, lws_hint());
149  }
151 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:267
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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 ...
Definition: ICLKernel.h:145
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
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:307
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.
Definition: ICLKernel.h:134
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#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_2D_tensor_argument(), ICLKernel::add_2D_tensor_argument_if(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_2D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_2D(), and IKernel::window().


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