Compute Library
 22.05
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 CLCompileContext &compile_context, 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...
 
CLKernelType type () const
 Returns the CL kernel type. 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...
 
void add_5D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 5D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_3d_tensor_nhw_argument (unsigned int &idx, const ICLTensor *tensor)
 Add the passed NHW 3D tensor's parameters to the object's kernel's arguments by passing strides, dimensions and the offset to the first valid element in bytes. More...
 
void add_4d_tensor_nhwc_argument (unsigned int &idx, const ICLTensor *tensor)
 Add the passed NHWC 4D tensor's parameters to the object's kernel's arguments by passing strides, dimensions and the offset to the first valid element in bytes. More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
virtual void run_composite_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue, const experimental::dynamic_fusion::ClExecutionDescriptor &exec_desc)
 The execution is carried out through run_op method. But the run_op method needs to be extended to include ClExecutionDescriptor as now LWS GWS tuning will be separated from the IKernel. 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...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier 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<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
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...
 
- 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...
 
bool is_window_configured () const
 Function to check if the embedded window of this kernel has been configured. 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_3d_tensor_nhw ()
 Returns the number of arguments enqueued per NHW 3D Tensor object. More...
 
static constexpr unsigned int num_arguments_per_4d_tensor_nhwc ()
 Returns the number of arguments enqueued per NHWC 4D Tensor object. More...
 
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 65 of file CLSelectKernel.cpp.

References arm_compute::ELEMENTWISE.

66  : _c(nullptr), _x(nullptr), _y(nullptr), _output(nullptr), _has_same_rank(false)
67 {
69 }
Elementeise CL kernel type.
Definition: CLTypes.h:84

◆ 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 CLCompileContext compile_context,
const ICLTensor c,
const ICLTensor x,
const ICLTensor y,
ICLTensor output 
)

Initialise the kernel's inputs and output.

Parameters
[in]compile_contextThe compile context to be used.
[in]cCondition input tensor. Data types supported: U8.
[in]xFirst input tensor. Data types supported: All.
[out]ySecond input tensor. Data types supported: Same as x
[in]outputOutput tensor. Data types supported: Same as x.

Definition at line 71 of file CLSelectKernel.cpp.

References CLBuildOptions::add_option(), arm_compute::adjust_vec_size(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), ICloneable< T >::clone(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::get_cl_unsigned_type_from_element_size(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), kernel_name, 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::cpu::kernels::validate_arguments(), Dimensions< T >::x(), and Dimensions< T >::y().

72 {
73  ARM_COMPUTE_ERROR_ON_NULLPTR(c, x, y, output);
74  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(c->info(), x->info(), y->info(), output->info()));
75 
76  _c = c;
77  _x = x;
78  _y = y;
79  _output = output;
80  _has_same_rank = (c->info()->tensor_shape().num_dimensions() == x->info()->tensor_shape().num_dimensions());
81 
82  auto padding_info = get_padding_info({ c, x, y, output });
83  const unsigned int vec_size_x = adjust_vec_size(16 / x->info()->element_size(), x->info()->dimension(0));
84  const int vec_size_x_leftovers = output->info()->dimension(0) % vec_size_x;
85 
86  // Set build options
87  CLBuildOptions build_opts;
88  build_opts.add_option("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(x->info()->element_size()));
89  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(vec_size_x));
90  build_opts.add_option("-DVEC_SIZE_LEFTOVER=" + support::cpp11::to_string(vec_size_x_leftovers));
91 
92  // Create kernel
93  std::string kernel_name = "select";
94  if(_has_same_rank)
95  {
96  kernel_name += "_same_rank";
97  }
98  else
99  {
100  const bool is_input_rank_greater_than_two = x->info()->tensor_shape().num_dimensions() > 2;
101  if(is_input_rank_greater_than_two)
102  {
103  const size_t width = x->info()->tensor_shape().x();
104  const size_t height = x->info()->tensor_shape().y();
105  const size_t outer_size = x->info()->tensor_shape()[x->info()->tensor_shape().num_dimensions() - 1];
106  const size_t depth_size = x->info()->tensor_shape().total_size() / (width * height * outer_size);
107  build_opts.add_option("-DDEPTH_SIZE=" + support::cpp11::to_string(depth_size));
108  }
109  kernel_name += "_different_rank";
110  kernel_name += is_input_rank_greater_than_two ? "_n" : "_2";
111  }
112  _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
113 
114  // Configure kernel window
115  auto_init_if_empty(*output->info(), *x->info()->clone());
116  Window win = calculate_max_window(*x->info(), Steps(vec_size_x));
117  ICLKernel::configure_internal(win);
118 
119  _config_id = "select_";
120  _config_id += string_from_data_type(x->info()->data_type());
121  _config_id += "_";
122  _config_id += support::cpp11::to_string(x->info()->dimension(0));
123  _config_id += "_";
124  _config_id += support::cpp11::to_string(x->info()->dimension(1));
125  _config_id += "_";
126  _config_id += support::cpp11::to_string(x->info()->dimension(2));
128 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:391
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
bool has_padding_changed(const std::unordered_map< const ITensorInfo *, PaddingSize > &padding_map)
Check if the previously stored padding info has changed after configuring a kernel.
Definition: Utils.cpp:601
std::string get_cl_unsigned_type_from_element_size(size_t element_size)
Translates the element size to an unsigned integer data type.
Definition: CLHelpers.cpp:105
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo *> infos)
Stores padding information before configuring a kernel.
Definition: Utils.cpp:586
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
unsigned int adjust_vec_size(unsigned int vec_size, size_t dim0)
Returns the adjusted vector size in case it is less than the input&#39;s first dimension, getting rounded down to its closest valid vector size.
Definition: Utils.h:1222
std::string kernel_name

◆ 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.

Reimplemented from ICLKernel.

Definition at line 136 of file CLSelectKernel.cpp.

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().

137 {
140 
142  Window slice = collapsed.first_slice_window_3D();
143 
144  if(!_has_same_rank)
145  {
146  Window vector_slice = window.first_slice_window_1D();
147  vector_slice.set(Window::DimX, Window::Dimension(0, 0, 0));
148  unsigned int idx = 0;
149  add_1D_tensor_argument(idx, _c, vector_slice);
150  }
151 
152  do
153  {
154  unsigned int idx = _has_same_rank ? 0 : num_arguments_per_1D_tensor();
155  if(_has_same_rank)
156  {
157  add_3D_tensor_argument(idx, _c, slice);
158  }
159  add_3D_tensor_argument(idx, _x, slice);
160  add_3D_tensor_argument(idx, _y, slice);
161  add_3D_tensor_argument(idx, _output, slice);
162 
163  enqueue(queue, *this, slice, lws_hint());
164  }
165  while(collapsed.slide_window_slice_3D(slice));
166 }
static constexpr unsigned int num_arguments_per_1D_tensor()
Returns the number of arguments enqueued per 1D tensor object.
Definition: ICLKernel.h:298
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:32
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:384
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:227
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:68
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
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&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:179
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
Window first_slice_window_1D() const
First 1D slice of the window.
Definition: Window.h:288
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ 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: All.
[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 130 of file CLSelectKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::cpu::kernels::validate_arguments().

Referenced by CLSelect::validate().

131 {
133  return Status{};
134 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)

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