Compute Library
 22.11
CLComparisonKernel Class Reference

Interface for the comparison kernel. More...

#include <CLComparisonKernel.h>

Collaboration diagram for CLComparisonKernel:
[legend]

Public Member Functions

 CLComparisonKernel ()
 Default constructor. More...
 
 CLComparisonKernel (const CLComparisonKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLComparisonKerneloperator= (const CLComparisonKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLComparisonKernel (CLComparisonKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLComparisonKerneloperator= (CLComparisonKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLComparisonKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation)
 Set the inputs and output tensors. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation)
 Set the inputs 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...
 
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...
 
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...
 
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 *input1, const ITensorInfo *input2, const ITensorInfo *output, ComparisonOperation operation)
 Static function to check if given info will lead to a valid configuration of CLComparisonKernel. 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

Interface for the comparison kernel.

Definition at line 36 of file CLComparisonKernel.h.

Constructor & Destructor Documentation

◆ CLComparisonKernel() [1/3]

Default constructor.

Definition at line 101 of file CLComparisonKernel.cpp.

References arm_compute::ELEMENTWISE.

102  : _input1(nullptr), _input2(nullptr), _output(nullptr)
103 {
105 }
Elementwise CL kernel type.
Definition: CLTypes.h:85

◆ CLComparisonKernel() [2/3]

CLComparisonKernel ( const CLComparisonKernel )
delete

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

◆ CLComparisonKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLComparisonKernel()

~CLComparisonKernel ( )
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 218 of file CLComparisonKernel.cpp.

References ITensorInfo::dimension(), ITensor::info(), and arm_compute::U.

219 {
220  const int num_elems_processed_per_iteration = calculate_num_elems_processed_per_iteration(*_input1->info());
221 
222  const unsigned int replicateSize = _output->info()->dimension(0) - std::min(_input1->info()->dimension(0), _input2->info()->dimension(0));
223  const unsigned int border = std::min<unsigned int>(num_elems_processed_per_iteration - 1U, replicateSize);
224  return BorderSize{ 0, border, 0, 0 };
225 }
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
unsigned int num_elems_processed_per_iteration
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.

◆ configure() [1/2]

void configure ( const ICLTensor input1,
const ICLTensor input2,
ICLTensor output,
ComparisonOperation  operation 
)

Set the inputs and output tensors.

Parameters
[in]input1Source tensor. Data types supported: All.
[in]input2Source tensor. Data types supported: Same as input1.
[out]outputDestination tensor. Data types supported: U8.
[in]operationComparison operation to use.

Definition at line 107 of file CLComparisonKernel.cpp.

References CLKernelLibrary::get().

108 {
109  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, operation);
110 }
void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation)
Set the inputs and output tensors.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input1,
const ICLTensor input2,
ICLTensor output,
ComparisonOperation  operation 
)

Set the inputs and output tensors.

Parameters
[in]compile_contextThe compile context to be used.
[in]input1Source tensor. Data types supported: All.
[in]input2Source tensor. Data types supported: Same as input1.
[out]outputDestination tensor. Data types supported: U8.
[in]operationComparison operation to use.

Definition at line 112 of file CLComparisonKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::float_to_string_with_full_precision(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::is_data_type_quantized(), kernel_name, arm_compute::lower_string(), UniformQuantizationInfo::offset, ITensorInfo::quantization_info(), UniformQuantizationInfo::scale, arm_compute::string_from_data_layout(), arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), QuantizationInfo::uniform(), arm_compute::cpu::kernels::validate_and_configure_window(), and arm_compute::cpu::kernels::validate_arguments().

113 {
114  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
115  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(*input1->info(), *input2->info(), *output->info(), operation));
116 
117  // Configure kernel window
118  auto win_config = validate_and_configure_window(*input1->info(), *input2->info(), *output->info());
119  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
120 
121  _input1 = input1;
122  _input2 = input2;
123  _output = output;
124 
125  const std::string &operation_name = supported_comparison_ops.at(operation);
126  std::string kernel_name = "compare_" + lower_string(operation_name);
127 
128  // Set kernel build options
129  std::set<std::string> build_opts;
130  build_opts.emplace("-DDATA_TYPE=" + get_cl_type_from_data_type(input1->info()->data_type()));
131  build_opts.emplace("-DVEC_SIZE=" + support::cpp11::to_string(calculate_num_elems_processed_per_iteration(*input1->info())));
132  build_opts.emplace("-DOP=" + operation_name);
133  build_opts.emplace("-DOP_NAME=" + lower_string(operation_name));
134  if(is_data_type_quantized(input1->info()->data_type()))
135  {
136  const UniformQuantizationInfo iq1_info = input1->info()->quantization_info().uniform();
137  const UniformQuantizationInfo iq2_info = input2->info()->quantization_info().uniform();
138 
139  build_opts.emplace("-DOFFSET_IN1=" + support::cpp11::to_string(iq1_info.offset));
140  build_opts.emplace("-DOFFSET_IN2=" + support::cpp11::to_string(iq2_info.offset));
141  build_opts.emplace("-DSCALE_IN1=" + float_to_string_with_full_precision(iq1_info.scale));
142  build_opts.emplace("-DSCALE_IN2=" + float_to_string_with_full_precision(iq2_info.scale));
143  kernel_name += "_quantized";
144  }
145 
146  // Create kernel
147  _kernel = create_kernel(compile_context, kernel_name, build_opts);
148 
149  ICLKernel::configure_internal(win_config.second);
150 
151  // Set config_id for enabling LWS tuning
152  _config_id = kernel_name;
153  _config_id += "_";
154  _config_id += lower_string(string_from_data_type(input1->info()->data_type()));
155  _config_id += "_";
156  _config_id += support::cpp11::to_string(output->info()->dimension(0));
157  _config_id += "_";
158  _config_id += support::cpp11::to_string(output->info()->dimension(1));
159  _config_id += lower_string(string_from_data_layout(input1->info()->data_layout()));
160 }
bool is_data_type_quantized(DataType dt)
Check if a given data type is of quantized type.
Definition: Utils.h:1030
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:353
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:404
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1124
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:39
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *src, ITensorInfo *dst)
const std::string & string_from_data_layout(DataLayout dl)
Convert a data layout identity into a string.
Definition: Utils.cpp:123
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
std::string kernel_name

◆ operator=() [1/2]

CLComparisonKernel& operator= ( const CLComparisonKernel )
delete

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

◆ operator=() [2/2]

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

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, Window::broadcast_if_dimension_le_one(), Window::collapse_if_possible(), TensorShape::collapsed_from(), Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), ITensor::info(), ICLKernel::lws_hint(), Dimensions< T >::num_dimensions(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), ITensorInfo::tensor_shape(), TensorShape::total_size(), and IKernel::window().

173 {
176 
177  const TensorShape &in_shape1 = _input1->info()->tensor_shape();
178  const TensorShape &in_shape2 = _input2->info()->tensor_shape();
179  const TensorShape &out_shape = _output->info()->tensor_shape();
180 
181  bool can_collapse = true;
182  const bool is_vector = in_shape1.num_dimensions() == 1 || in_shape2.num_dimensions() == 1;
183  if(std::min(in_shape1.total_size(), in_shape2.total_size()) > 1 && !is_vector)
184  {
185  can_collapse = (std::min(in_shape1.num_dimensions(), in_shape2.num_dimensions()) > Window::DimZ);
186  for(size_t d = Window::DimZ; can_collapse && (d < out_shape.num_dimensions()); d++)
187  {
188  can_collapse = (in_shape1[d] == in_shape2[d]);
189  }
190  }
191 
192  bool has_collapsed = false;
193  Window collapsed = can_collapse ? window.collapse_if_possible(ICLKernel::window(), Window::DimZ, &has_collapsed) : window;
194 
195  const TensorShape &in_shape1_collapsed = has_collapsed ? in_shape1.collapsed_from(Window::DimZ) : in_shape1;
196  const TensorShape &in_shape2_collapsed = has_collapsed ? in_shape2.collapsed_from(Window::DimZ) : in_shape2;
197 
198  Window slice = collapsed.first_slice_window_3D();
199  Window slice_input1 = slice.broadcast_if_dimension_le_one(in_shape1_collapsed);
200  Window slice_input2 = slice.broadcast_if_dimension_le_one(in_shape2_collapsed);
201 
202  do
203  {
204  unsigned int idx = 0;
205 
206  add_3D_tensor_argument(idx, _input1, slice_input1);
207  add_3D_tensor_argument(idx, _input2, slice_input2);
208  add_3D_tensor_argument(idx, _output, slice);
209 
210  enqueue(queue, *this, slice, lws_hint());
211 
212  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input1));
213  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input2));
214  }
215  while(collapsed.slide_window_slice_3D(slice));
216 }
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:383
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:226
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
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
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
#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
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:143
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input1,
const ITensorInfo input2,
const ITensorInfo output,
ComparisonOperation  operation 
)
static

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

Parameters
[in]input1Source tensor. Data types supported: All.
[in]input2Source tensor. Data types supported: Same as input1.
[in]outputDestination tensor. Data types supported: U8.
[in]operationComparison operation to use.
Returns
a status

Definition at line 162 of file CLComparisonKernel.cpp.

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), arm_compute::cpu::kernels::validate_and_configure_window(), and arm_compute::cpu::kernels::validate_arguments().

Referenced by CLComparison::validate(), and CLComparisonStatic< COP >::validate().

163 {
164  ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input1, input2, output);
165 
166  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(*input1, *input2, *output, operation));
167  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(*input1->clone(), *input2->clone(), *output->clone()).first);
168 
169  return Status{};
170 }
#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)
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *src, ITensorInfo *dst)

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