Compute Library
 21.02
CLComplexPixelWiseMultiplicationKernel Class Reference

Interface for the complex pixelwise multiplication kernel. More...

#include <CLPixelWiseMultiplicationKernel.h>

Collaboration diagram for CLComplexPixelWiseMultiplicationKernel:
[legend]

Public Member Functions

 CLComplexPixelWiseMultiplicationKernel ()
 Default constructor. More...
 
 CLComplexPixelWiseMultiplicationKernel (const CLComplexPixelWiseMultiplicationKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLComplexPixelWiseMultiplicationKerneloperator= (const CLComplexPixelWiseMultiplicationKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLComplexPixelWiseMultiplicationKernel (CLComplexPixelWiseMultiplicationKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLComplexPixelWiseMultiplicationKerneloperator= (CLComplexPixelWiseMultiplicationKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's input, output and border mode. More...
 
void configure (const CLCompileContext &compile_context, ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's input, output and border mode. More...
 
void run_op (ITensorPack &tensors, 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...
 
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...
 
virtual void run (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...
 
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...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Static function to check if given info will lead to a valid configuration of CLComplexPixelWiseMultiplicationKernel. 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

Interface for the complex pixelwise multiplication kernel.

Definition at line 145 of file CLPixelWiseMultiplicationKernel.h.

Constructor & Destructor Documentation

◆ CLComplexPixelWiseMultiplicationKernel() [1/3]

Default constructor.

Definition at line 381 of file CLPixelWiseMultiplicationKernel.cpp.

382  : _input1(nullptr), _input2(nullptr), _output(nullptr)
383 {
384 }

◆ CLComplexPixelWiseMultiplicationKernel() [2/3]

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

◆ CLComplexPixelWiseMultiplicationKernel() [3/3]

Allow instances of this class to be moved.

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 475 of file CLPixelWiseMultiplicationKernel.cpp.

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

476 {
477  const unsigned int replicateSize = _output->dimension(0) - std::min(_input1->dimension(0), _input2->dimension(0));
478  const unsigned int border = std::min<unsigned int>(num_elems_processed_per_iteration_complex - 1U, replicateSize);
479  return BorderSize{ 0, border, 0, 0 };
480 }
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.

◆ configure() [1/2]

void configure ( ITensorInfo input1,
ITensorInfo input2,
ITensorInfo output,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)

Initialise the kernel's input, output and border mode.

Parameters
[in]input1An input tensor info. Data types supported: F16/F32. Number of channels supported: 2.
[in]input2An input tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[out]outputThe output tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 386 of file CLPixelWiseMultiplicationKernel.cpp.

References CLKernelLibrary::get().

387 {
388  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, act_info);
389 }
void configure(ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Initialise the kernel&#39;s input, output and border mode.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ITensorInfo input1,
ITensorInfo input2,
ITensorInfo output,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)

Initialise the kernel's input, output and border mode.

Parameters
[in]compile_contextThe compile context to be used.
[in]input1An input tensor info. Data types supported: F32. Number of channels supported: 2.
[in]input2An input tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[out]outputThe output tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 391 of file CLPixelWiseMultiplicationKernel.cpp.

References ActivationLayerInfo::a(), ActivationLayerInfo::activation(), CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ActivationLayerInfo::b(), arm_compute::create_kernel(), ITensorInfo::data_type(), ActivationLayerInfo::enabled(), arm_compute::float_to_string_with_full_precision(), arm_compute::get_cl_type_from_data_type(), arm_compute::lower_string(), CLBuildOptions::options(), and arm_compute::string_from_activation_func().

392 {
393  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
394  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments_complex(input1, input2, output, act_info));
395 
396  // Configure kernel window
397  auto win_config = validate_and_configure_window_complex(input1, input2, output);
398  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
399 
400  _input1 = input1;
401  _input2 = input2;
402  _output = output;
403 
404  CLBuildOptions build_opts;
405  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(_output->data_type()));
406  if(act_info.enabled())
407  {
408  build_opts.add_option("-DACTIVATION_TYPE=" + lower_string(string_from_activation_func(act_info.activation())));
409  build_opts.add_option("-DA_VAL=" + float_to_string_with_full_precision(act_info.a()));
410  build_opts.add_option("-DB_VAL=" + float_to_string_with_full_precision(act_info.b()));
411  }
412 
413  // Create kernel
414  _kernel = create_kernel(compile_context, "pixelwise_mul_complex", build_opts.options());
415 
416  ICLKernel::configure_internal(win_config.second);
417 }
virtual DataType data_type() const =0
Data type used for each element of the tensor.
const std::string & string_from_activation_func(ActivationLayerInfo::ActivationFunction act)
Translates a given activation function to a string.
Definition: Utils.cpp:163
#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:350
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:403
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1262
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

◆ operator=() [1/2]

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

◆ operator=() [2/2]

Allow instances of this class to be moved.

◆ run_op()

void run_op ( ITensorPack tensors,
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]tensorsA vector containing the tensors to operato on.
[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 428 of file CLPixelWiseMultiplicationKernel.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, 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::test::validation::dst, arm_compute::enqueue(), Window::first_slice_window_3D(), ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), ICLKernel::lws_hint(), Dimensions< T >::num_dimensions(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), TensorShape::total_size(), and IKernel::window().

429 {
432 
433  const auto src_0 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_0));
434  const auto src_1 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_1));
435  auto dst = utils::cast::polymorphic_downcast<ICLTensor *>(tensors.get_tensor(TensorType::ACL_DST));
436 
437  const TensorShape &in_shape1 = src_0->info()->tensor_shape();
438  const TensorShape &in_shape2 = src_1->info()->tensor_shape();
439  const TensorShape &out_shape = dst->info()->tensor_shape();
440 
441  bool can_collapse = true;
442  if(std::min(in_shape1.total_size(), in_shape2.total_size()) > 1)
443  {
444  can_collapse = (std::min(in_shape1.num_dimensions(), in_shape2.num_dimensions()) > Window::DimZ);
445  for(size_t d = Window::DimZ; can_collapse && (d < out_shape.num_dimensions()); ++d)
446  {
447  can_collapse = (in_shape1[d] == in_shape2[d]);
448  }
449  }
450 
451  bool has_collapsed = false;
452  Window collapsed = can_collapse ? window.collapse_if_possible(ICLKernel::window(), Window::DimZ, &has_collapsed) : window;
453 
454  const TensorShape &in_shape1_collapsed = has_collapsed ? in_shape1.collapsed_from(Window::DimZ) : in_shape1;
455  const TensorShape &in_shape2_collapsed = has_collapsed ? in_shape2.collapsed_from(Window::DimZ) : in_shape2;
456 
457  Window slice = collapsed.first_slice_window_3D();
458  Window slice_input1 = slice.broadcast_if_dimension_le_one(in_shape1_collapsed);
459  Window slice_input2 = slice.broadcast_if_dimension_le_one(in_shape2_collapsed);
460 
461  do
462  {
463  unsigned int idx = 0;
464  add_3D_tensor_argument(idx, src_0, slice_input1);
465  add_3D_tensor_argument(idx, src_1, slice_input2);
466  add_3D_tensor_argument(idx, dst, slice);
467  enqueue(queue, *this, slice, lws_hint());
468 
469  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input1));
470  ARM_COMPUTE_UNUSED(collapsed.slide_window_slice_3D(slice_input2));
471  }
472  while(collapsed.slide_window_slice_3D(slice));
473 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
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:172
#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
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input1,
const ITensorInfo input2,
const ITensorInfo output,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)
static

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

Parameters
[in]input1An input tensor info. Data types supported: F32. Number of channels supported: 2.
[in]input2An input tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[in]outputThe output tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.
Returns
a status

Definition at line 419 of file CLPixelWiseMultiplicationKernel.cpp.

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

Referenced by CLComplexPixelWiseMultiplication::validate().

420 {
421  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
422  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments_complex(input1, input2, output, act_info));
423  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window_complex(input1->clone().get(), input2->clone().get(), output->clone().get()).first);
424 
425  return Status{};
426 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

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