Compute Library
 23.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...
 
- 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...
 
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...
 
cl::NDRange get_cached_gws () const
 Get the cached gws used to enqueue this kernel. More...
 
void cache_gws (const cl::NDRange &gws)
 Cache the latest gws used to enqueue this kernel. 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 *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
constexpr static unsigned int num_arguments_per_3d_tensor_nhw ()
 Returns the number of arguments enqueued per NHW 3D Tensor object. More...
 
constexpr static unsigned int num_arguments_per_4d_tensor_nhwc ()
 Returns the number of arguments enqueued per NHWC 4D Tensor object. More...
 
constexpr static unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
constexpr static unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
constexpr static unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
constexpr static unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
constexpr static 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, bool use_dummy_work_items)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for the comparison kernel.

Definition at line 37 of file CLComparisonKernel.h.

Constructor & Destructor Documentation

◆ CLComparisonKernel() [1/3]

Default constructor.

Definition at line 88 of file CLComparisonKernel.cpp.

88  : _input1(nullptr), _input2(nullptr), _output(nullptr)
89 {
91 }

References arm_compute::ELEMENTWISE.

◆ 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

◆ configure() [1/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 101 of file CLComparisonKernel.cpp.

106 {
107  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
108  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(*input1->info(), *input2->info(), *output->info(), operation));
109 
110  // Configure kernel window
111  auto win_config = validate_and_configure_window(*input1->info(), *input2->info(), *output->info());
112  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
113 
114  _input1 = input1;
115  _input2 = input2;
116  _output = output;
117 
118  const std::string &operation_name = supported_comparison_ops.at(operation);
119  std::string kernel_name = "compare_" + lower_string(operation_name);
120 
121  const unsigned int num_elems_processed_per_iteration =
122  adjust_vec_size(16 / input1->info()->element_size(), output->info()->dimension(0));
123 
124  // Set kernel build options
125  std::set<std::string> build_opts;
126  build_opts.emplace("-DDATA_TYPE=" + get_cl_type_from_data_type(input1->info()->data_type()));
127  build_opts.emplace("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration));
128  build_opts.emplace("-DVEC_SIZE_LEFTOVER=" +
129  support::cpp11::to_string(output->info()->dimension(0) % num_elems_processed_per_iteration));
130  build_opts.emplace(
131  "-DVEC_SIZE_IN1=" + //
132  support::cpp11::to_string(input1->info()->dimension(0) == 1 ? 1 : num_elems_processed_per_iteration));
133  build_opts.emplace(
134  "-DVEC_SIZE_IN2=" + //
135  support::cpp11::to_string(input2->info()->dimension(0) == 1 ? 1 : num_elems_processed_per_iteration));
136  build_opts.emplace("-DOP=" + operation_name);
137  build_opts.emplace("-DOP_NAME=" + lower_string(operation_name));
138  if (is_data_type_quantized(input1->info()->data_type()))
139  {
140  const UniformQuantizationInfo iq1_info = input1->info()->quantization_info().uniform();
141  const UniformQuantizationInfo iq2_info = input2->info()->quantization_info().uniform();
142 
143  build_opts.emplace("-DIS_QUANTIZED");
144  build_opts.emplace("-DOFFSET_IN1=" + support::cpp11::to_string(iq1_info.offset));
145  build_opts.emplace("-DOFFSET_IN2=" + support::cpp11::to_string(iq2_info.offset));
146  build_opts.emplace("-DSCALE_IN1=" + float_to_string_with_full_precision(iq1_info.scale));
147  build_opts.emplace("-DSCALE_IN2=" + float_to_string_with_full_precision(iq2_info.scale));
148  kernel_name += "_quantized";
149  }
150 
151  // Create kernel
152  _kernel = create_kernel(compile_context, kernel_name, build_opts);
153 
154  ICLKernel::configure_internal(win_config.second);
155 
156  // Set config_id for enabling LWS tuning
157  _config_id = kernel_name;
158  _config_id += "_";
159  _config_id += lower_string(string_from_data_type(input1->info()->data_type()));
160  _config_id += "_";
161  _config_id += support::cpp11::to_string(output->info()->dimension(0));
162  _config_id += "_";
163  _config_id += support::cpp11::to_string(output->info()->dimension(1));
164  _config_id += lower_string(string_from_data_layout(input1->info()->data_layout()));
165 }

References arm_compute::adjust_vec_size(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), 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(), num_elems_processed_per_iteration, 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().

◆ configure() [2/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 93 of file CLComparisonKernel.cpp.

97 {
98  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, operation);
99 }

References CLKernelLibrary::get().

◆ operator=() [1/2]

CLComparisonKernel& operator= ( CLComparisonKernel &&  )
default

Allow instances of this class to be moved.

◆ operator=() [2/2]

CLComparisonKernel& operator= ( const CLComparisonKernel )
delete

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

◆ 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 181 of file CLComparisonKernel.cpp.

182 {
185 
186  const TensorShape &in_shape1 = _input1->info()->tensor_shape();
187  const TensorShape &in_shape2 = _input2->info()->tensor_shape();
188  const TensorShape &out_shape = _output->info()->tensor_shape();
189 
190  bool can_collapse = true;
191  const bool is_vector = in_shape1.num_dimensions() == 1 || in_shape2.num_dimensions() == 1;
192  if (std::min(in_shape1.total_size(), in_shape2.total_size()) > 1 && !is_vector)
193  {
194  can_collapse = (std::min(in_shape1.num_dimensions(), in_shape2.num_dimensions()) > Window::DimZ);
195  for (size_t d = Window::DimZ; can_collapse && (d < out_shape.num_dimensions()); d++)
196  {
197  can_collapse = (in_shape1[d] == in_shape2[d]);
198  }
199  }
200 
201  bool has_collapsed = false;
202  Window collapsed =
203  can_collapse ? window.collapse_if_possible(ICLKernel::window(), Window::DimZ, &has_collapsed) : window;
204 
205  const TensorShape &in_shape1_collapsed = has_collapsed ? in_shape1.collapsed_from(Window::DimZ) : in_shape1;
206  const TensorShape &in_shape2_collapsed = has_collapsed ? in_shape2.collapsed_from(Window::DimZ) : in_shape2;
207 
208  Window slice = collapsed.first_slice_window_3D();
209  Window slice_input1 = slice.broadcast_if_dimension_le_one(in_shape1_collapsed);
210  Window slice_input2 = slice.broadcast_if_dimension_le_one(in_shape2_collapsed);
211 
212  do
213  {
214  unsigned int idx = 0;
215 
216  add_3D_tensor_argument(idx, _input1, slice_input1);
217  add_3D_tensor_argument(idx, _input2, slice_input2);
218  add_3D_tensor_argument(idx, _output, slice);
219 
220  enqueue(queue, *this, slice, lws_hint());
221 
222  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input1));
223  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input2));
224  } while (collapsed.slide_window_slice_3D(slice));
225 }

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, 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().

◆ 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 167 of file CLComparisonKernel.cpp.

171 {
172  ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input1, input2, output);
173 
174  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(*input1, *input2, *output, operation));
176  validate_and_configure_window(*input1->clone(), *input2->clone(), *output->clone()).first);
177 
178  return Status{};
179 }

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


The documentation for this class was generated from the following files:
arm_compute::support::cpp11::to_string
std::string to_string(T &&value)
Convert integer and float values to string.
Definition: StringSupport.h:168
arm_compute::ITensorInfo::tensor_shape
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
arm_compute::lower_string
std::string lower_string(const std::string &val)
Lower a given string.
Definition: StringUtils.cpp:38
arm_compute::cpu::kernels::validate_arguments
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
Definition: CpuDirectConv2dKernel.cpp:57
ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:1079
arm_compute::Window::collapse_if_possible
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:72
arm_compute::string_from_data_type
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: DataTypeUtils.cpp:31
arm_compute::CLComparisonKernel::configure
void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ComparisonOperation operation)
Set the inputs and output tensors.
Definition: CLComparisonKernel.cpp:93
arm_compute::CLKernelLibrary::get
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Definition: CLKernelLibrary.cpp:41
ARM_COMPUTE_RETURN_ON_ERROR
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:205
ARM_COMPUTE_ERROR_ON_NULLPTR
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
arm_compute::ITensor::info
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
ARM_COMPUTE_ERROR_THROW_ON
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
arm_compute::create_kernel
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:409
ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:203
arm_compute::float_to_string_with_full_precision
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: StringUtils.cpp:52
arm_compute::cpu::kernels::validate_and_configure_window
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *src, ITensorInfo *dst)
Definition: CpuDirectConv2dKernel.cpp:92
ARM_COMPUTE_UNUSED
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:151
arm_compute::IKernel::window
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
arm_compute::string_from_data_layout
const std::string & string_from_data_layout(DataLayout dl)
Convert a data layout identity into a string.
Definition: DataLayoutUtils.cpp:30
arm_compute::get_cl_type_from_data_type
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:41
arm_compute::ICLKernel::add_3D_tensor_argument
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:234
arm_compute::ELEMENTWISE
@ ELEMENTWISE
Elementwise CL kernel type.
Definition: CLTypes.h:83
arm_compute::adjust_vec_size
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's first dimension,...
Definition: AdjustVecSize.h:38
arm_compute::Window::DimZ
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
arm_compute::ICLKernel::lws_hint
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:383
ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
arm_compute::is_data_type_quantized
bool is_data_type_quantized(DataType dt)
Check if a given data type is of quantized type.
Definition: DataTypeUtils.h:324
arm_compute::Dimensions::num_dimensions
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:142
num_elems_processed_per_iteration
unsigned int num_elems_processed_per_iteration
Definition: ClIm2ColKernel.cpp:60
arm_compute::test::validation::reference::slice
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)
Definition: SliceOperations.cpp:38
kernel_name
std::string kernel_name
Definition: ClIm2ColKernel.cpp:58
arm_compute::enqueue
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:33