Interface for the bitwise operation kernel. More...

#include <CLBitwiseKernel.h>

Collaboration diagram for CLBitwiseKernel:

Public Member Functions
	CLBitwiseKernel ()
	Default constructor. More...

	CLBitwiseKernel (const CLBitwiseKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...

CLBitwiseKernel &	operator= (const CLBitwiseKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...

	CLBitwiseKernel (CLBitwiseKernel &&)=default
	Allow instances of this class to be moved. More...

CLBitwiseKernel &	operator= (CLBitwiseKernel &&)=default
	Allow instances of this class to be moved. More...

void	configure (const CLCompileContext &compile_context, const ICLTensor input1, const ICLTensor input2, ICLTensor *output, BitwiseOperation op)
	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 Window &	window () 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...

Additional Inherited Members
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 bitwise operation kernel.

Result depends on the BitwiseOperation and is computed by: AND operation:

\[ output(x,y) = input1(x,y) \land input2(x,y) \]

NOT operation:

\[ output(x,y) = \lnot input1(x,y) \]

OR operation:

\[ output(x,y) = input1(x,y) \lor input2(x,y) \]

XOR operation:

\[ output(x,y) = input1(x,y) \oplus input2(x,y) \]

Definition at line 41 of file CLBitwiseKernel.h.

Constructor & Destructor Documentation

◆ CLBitwiseKernel() [1/3]

CLBitwiseKernel ( )

Default constructor.

Definition at line 40 of file CLBitwiseKernel.cpp.

                                  : _input1(nullptr), _input2(nullptr), _output(nullptr)
 {
     _type = CLKernelType::ELEMENTWISE;
 }

References arm_compute::ELEMENTWISE.

◆ CLBitwiseKernel() [2/3]

CLBitwiseKernel ( const CLBitwiseKernel & )

delete

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

◆ CLBitwiseKernel() [3/3]

CLBitwiseKernel ( CLBitwiseKernel && )

default

Allow instances of this class to be moved.

Member Function Documentation

◆ configure()

void configure	(	const CLCompileContext &	compile_context,
		const ICLTensor *	input1,
		const ICLTensor *	input2,
		ICLTensor *	output,
		BitwiseOperation	op
	)

Set the inputs and output tensors.

Parameters

[in]	compile_context	The compile context to be used.
[in]	input1	Source tensor. Data types supported: U8.
[in]	input2	Source tensor. Data types supported: U8.
[out]	output	Destination tensor. Data types supported: U8.
[in]	op	Bitwise operation to perform. Supported: AND, OR, NOT, XOR.

Definition at line 45 of file CLBitwiseKernel.cpp.

 {
     ARM_COMPUTE_ERROR_ON_NULLPTR(input1);
     ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input1, 1, DataType::U8);
     if (op != BitwiseOperation::NOT)
     {
         ARM_COMPUTE_ERROR_ON_NULLPTR(input2);
         ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input2, 1, DataType::U8);
     }
     ARM_COMPUTE_ERROR_ON_NULLPTR(output);
     ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output, 1, DataType::U8);
  
     // Output auto inizialitation if not yet initialized
     auto_init_if_empty(*(output->info()), *(input1->info()));
     auto padding_info = get_padding_info({input1, input2, output});
  
     // Configure kernel window
     const unsigned int vec_size_x = adjust_vec_size(16 / output->info()->element_size(), output->info()->dimension(0));
     Window             win        = calculate_max_window(*output->info(), Steps(vec_size_x));
  
     _input1 = input1;
     _input2 = input2;
     _output = output;
  
     // Create kernel
     std::string kernel_name = "";
     switch (op)
     {
         case BitwiseOperation::AND:
             kernel_name = "bitwise_and";
             break;
         case BitwiseOperation::NOT:
             kernel_name = "bitwise_not";
             break;
         case BitwiseOperation::OR:
             kernel_name = "bitwise_or";
             break;
         case BitwiseOperation::XOR:
             kernel_name = "bitwise_xor";
             break;
         default:
             ARM_COMPUTE_ERROR("Bitwise operation not supported");
     }
  
     CLBuildOptions build_opts;
     const int      vec_size_x_leftovers = output->info()->dimension(0) % vec_size_x;
     build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(vec_size_x));
     build_opts.add_option("-DVEC_SIZE_LEFTOVER=" + support::cpp11::to_string(vec_size_x_leftovers));
     _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
  
     ICLKernel::configure_internal(win);
     ARM_COMPUTE_ERROR_ON(has_padding_changed(padding_info));
 }

References CLBuildOptions::add_option(), arm_compute::adjust_vec_size(), arm_compute::AND, ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_NULLPTR, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), kernel_name, arm_compute::NOT, CLBuildOptions::options(), arm_compute::OR, arm_compute::support::cpp11::to_string(), arm_compute::U8, and arm_compute::XOR.

◆ operator=() [1/2]

CLBitwiseKernel& operator= ( CLBitwiseKernel && )

default

Allow instances of this class to be moved.

◆ operator=() [2/2]

CLBitwiseKernel& operator= ( const CLBitwiseKernel & )

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]	window	Region on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]	queue	Command queue on which to enqueue the kernel.

Reimplemented from ICLKernel.

Definition at line 103 of file CLBitwiseKernel.cpp.

 {
     ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
     ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window);
  
     Window slice = window.first_slice_window_2D();
  
     do
     {
         unsigned int idx = 0;
         add_2D_tensor_argument(idx, _input1, slice);
         if (_input2 != nullptr)
         {
             add_2D_tensor_argument(idx, _input2, slice);
         }
         add_2D_tensor_argument(idx, _output, slice);
         enqueue(queue, *this, slice, lws_hint());
     } while (window.slide_window_slice_2D(slice));
 }

References ICLKernel::add_2D_tensor_argument(), 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:

src/core/CL/kernels/CLBitwiseKernel.h
src/core/CL/kernels/CLBitwiseKernel.cpp

Public Member Functions

Additional Inherited Members