Compute Library
 19.08
CLSelectKernel Class Reference

OpenCL interface for executing the select kernel. More...

#include <CLSelectKernel.h>

Collaboration diagram for CLSelectKernel:
[legend]

Public Member Functions

 CLSelectKernel ()
 Default constructor. More...
 
 CLSelectKernel (const CLSelectKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLSelectKerneloperator= (const CLSelectKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLSelectKernel (CLSelectKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLSelectKerneloperator= (CLSelectKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLSelectKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *c, const ICLTensor *x, const ICLTensor *y, ICLTensor *output)
 Initialise the kernel's inputs and output. 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 *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output)
 Static function to check if given info will lead to a valid configuration of CLSelectKernel. 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

OpenCL interface for executing the select kernel.

Select is computed by:

\[ output(i) = condition(i) ? x(i) : y(i) \]

Definition at line 40 of file CLSelectKernel.h.

Constructor & Destructor Documentation

◆ CLSelectKernel() [1/3]

Default constructor.

Definition at line 105 of file CLSelectKernel.cpp.

106  : _c(nullptr), _x(nullptr), _y(nullptr), _output(nullptr), _has_same_rank(false)
107 {
108 }

◆ CLSelectKernel() [2/3]

CLSelectKernel ( const CLSelectKernel )
delete

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

◆ CLSelectKernel() [3/3]

CLSelectKernel ( CLSelectKernel &&  )
default

Allow instances of this class to be moved.

◆ ~CLSelectKernel()

~CLSelectKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor c,
const ICLTensor x,
const ICLTensor y,
ICLTensor output 
)

Initialise the kernel's inputs and output.

Parameters
[in]cCondition input tensor. Data types supported: U8.
[in]xFirst input tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
[out]ySecond input tensor. Data types supported: Same as x
[in]outputOutput tensor. Data types supported: Same as x.

Definition at line 109 of file CLSelectKernel.cpp.

110 {
111  ARM_COMPUTE_ERROR_ON_NULLPTR(c, x, y, output);
112  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(c->info(), x->info(), y->info(), output->info()));
113 
114  _c = c;
115  _x = x;
116  _y = y;
117  _output = output;
118  _has_same_rank = (c->info()->tensor_shape().num_dimensions() == x->info()->tensor_shape().num_dimensions());
119 
120  const unsigned int num_elems_processed_per_iteration = 16 / x->info()->element_size();
121 
122  // Set build options
123  CLBuildOptions build_opts;
124  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(x->info()->data_type()));
125  build_opts.add_option("-DSELECT_DATA_TYPE=" + get_cl_select_type_from_data_type(x->info()->data_type()));
126  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration));
127 
128  // Create kernel
129  std::string kernel_name = "select";
130  if(_has_same_rank)
131  {
132  kernel_name += "_same_rank";
133  }
134  else
135  {
136  const bool is_input_rank_greater_than_two = x->info()->tensor_shape().num_dimensions() > 2;
137  if(is_input_rank_greater_than_two)
138  {
139  const size_t width = x->info()->tensor_shape().x();
140  const size_t height = x->info()->tensor_shape().y();
141  const size_t outer_size = x->info()->tensor_shape()[x->info()->tensor_shape().num_dimensions() - 1];
142  const size_t depth_size = x->info()->tensor_shape().total_size() / (width * height * outer_size);
143  build_opts.add_option("-DDEPTH_SIZE=" + support::cpp11::to_string(depth_size));
144  }
145  kernel_name += "_different_rank";
146  kernel_name += is_input_rank_greater_than_two ? "_n" : "_2";
147  }
148  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
149 
150  // Configure kernel window
151  auto win_config = validate_and_configure_window(c->info(), x->info(), y->info(), output->info());
152  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
153  ICLKernel::configure_internal(win_config.second);
154 
155  _config_id = "select_";
156  _config_id += string_from_data_type(x->info()->data_type());
157  _config_id += "_";
158  _config_id += support::cpp11::to_string(x->info()->dimension(0));
159  _config_id += "_";
160  _config_id += support::cpp11::to_string(x->info()->dimension(1));
161  _config_id += "_";
162  _config_id += support::cpp11::to_string(x->info()->dimension(2));
163 }
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 get_cl_select_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL select type.
Definition: CLHelpers.cpp:68
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
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:35
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(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), CLKernelLibrary::get(), arm_compute::get_cl_select_type_from_data_type(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), Dimensions< T >::num_dimensions(), CLBuildOptions::options(), arm_compute::string_from_data_type(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), TensorShape::total_size(), arm_compute::validate_and_configure_window(), Dimensions< T >::x(), and Dimensions< T >::y().

◆ operator=() [1/2]

CLSelectKernel& operator= ( const CLSelectKernel )
delete

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

◆ operator=() [2/2]

CLSelectKernel& operator= ( CLSelectKernel &&  )
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 172 of file CLSelectKernel.cpp.

173 {
176 
178  Window slice = collapsed.first_slice_window_3D();
179 
180  if(!_has_same_rank)
181  {
182  Window vector_slice = window.first_slice_window_1D();
183  vector_slice.set(Window::DimX, Window::Dimension(0, 0, 0));
184  unsigned int idx = 0;
185  add_1D_tensor_argument(idx, _c, vector_slice);
186  }
187 
188  do
189  {
190  unsigned int idx = _has_same_rank ? 0 : num_arguments_per_1D_tensor();
191  if(_has_same_rank)
192  {
193  add_3D_tensor_argument(idx, _c, slice);
194  }
195  add_3D_tensor_argument(idx, _x, slice);
196  add_3D_tensor_argument(idx, _y, slice);
197  add_3D_tensor_argument(idx, _output, slice);
198 
199  enqueue(queue, *this, slice, lws_hint());
200  }
201  while(collapsed.slide_window_slice_3D(slice));
202 }
static constexpr unsigned int num_arguments_per_1D_tensor()
Returns the number of arguments enqueued per 1D tensor object.
Definition: ICLKernel.h:184
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
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
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
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:48
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
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.
Definition: ICLKernel.h:110
#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
Window first_slice_window_1D() const
First 1D slice of the window.
Definition: Window.h:259
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

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

◆ validate()

Status validate ( const ITensorInfo c,
const ITensorInfo x,
const ITensorInfo y,
const ITensorInfo output 
)
static

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

Parameters
[in]cCondition input tensor. Data types supported: U8.
[in]xFirst input tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
[in]ySecond input tensor. Data types supported: Same as x
[in]outputOutput tensor. Data types supported: Same as x.
Returns
a status

Definition at line 165 of file CLSelectKernel.cpp.

166 {
167  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(c, x, y, output));
168  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(c->clone().get(), x->clone().get(), y->clone().get(), output->clone().get()).first);
169  return Status{};
170 }
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

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

Referenced by CLSelect::validate().


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