Compute Library
 19.08
GCPixelWiseMultiplicationKernel Class Reference

Interface for the pixelwise multiplication kernel. More...

#include <GCPixelWiseMultiplicationKernel.h>

Collaboration diagram for GCPixelWiseMultiplicationKernel:
[legend]

Public Member Functions

 GCPixelWiseMultiplicationKernel ()
 Default constructor. More...
 
 GCPixelWiseMultiplicationKernel (const GCPixelWiseMultiplicationKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
GCPixelWiseMultiplicationKerneloperator= (const GCPixelWiseMultiplicationKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 GCPixelWiseMultiplicationKernel (GCPixelWiseMultiplicationKernel &&)=default
 Allow instances of this class to be moved. More...
 
GCPixelWiseMultiplicationKerneloperator= (GCPixelWiseMultiplicationKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const IGCTensor *input1, const IGCTensor *input2, IGCTensor *output, float scale)
 Initialise the kernel's input, output and border mode. More...
 
void run (const Window &window) override
 Enqueue the OpenGL ES shader to process the given window. More...
 
- Public Member Functions inherited from IGCKernel
 IGCKernel ()
 Constructor. More...
 
GCKernelkernel ()
 Returns a reference to the GLES kernel of this object. More...
 
void add_1D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, 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_2D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, 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_3D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
unsigned int num_arguments_per_1D_tensor () const
 Returns the number of arguments enqueued per 1D tensor object. More...
 
unsigned int num_arguments_per_2D_tensor () const
 Returns the number of arguments enqueued per 2D tensor object. More...
 
unsigned int num_arguments_per_3D_tensor () const
 Returns the number of arguments enqueued per 3D tensor object. More...
 
void set_lws_hint (gles::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. 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...
 

Detailed Description

Interface for the pixelwise multiplication kernel.

Definition at line 37 of file GCPixelWiseMultiplicationKernel.h.

Constructor & Destructor Documentation

◆ GCPixelWiseMultiplicationKernel() [1/3]

Default constructor.

Definition at line 42 of file GCPixelWiseMultiplicationKernel.cpp.

43  : _input1(nullptr), _input2(nullptr), _output(nullptr)
44 {
45 }

◆ GCPixelWiseMultiplicationKernel() [2/3]

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

◆ GCPixelWiseMultiplicationKernel() [3/3]

Allow instances of this class to be moved.

Member Function Documentation

◆ configure()

void configure ( const IGCTensor input1,
const IGCTensor input2,
IGCTensor output,
float  scale 
)

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

Parameters
[in]input1An input tensor. Data types supported: F32.
[in]input2An input tensor. Data types supported: same as input1.
[out]outputThe output tensor, Data types supported: same as input1.
[in]scaleScale to apply after multiplication. Scale must be positive and its value must be either 1/255 or 1/2^n where n is between 0 and 15.

Definition at line 47 of file GCPixelWiseMultiplicationKernel.cpp.

48 {
49  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
53  ARM_COMPUTE_ERROR_ON_MSG(scale < 0, "Scale cannot be negative. ");
54 
55  // Auto initialize output if not initialized
56  {
57  set_shape_if_empty(*output->info(), input1->info()->tensor_shape());
59  }
60 
61  ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES(input1, input2, output);
62  ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(input1, input2, output);
63  ARM_COMPUTE_ERROR_ON_MSG(scale < 0, "Scale cannot be negative. ");
64 
65  _input1 = input1;
66  _input2 = input2;
67  _output = output;
68 
69  std::string data_type;
70  std::string compute_type;
71 
72  // Set kernel build options
73  std::set<std::string> build_opts;
74  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(1));
75  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1));
76  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1));
77 
78  build_opts.emplace("#define SCALE " + support::cpp11::to_string(scale));
79 
80  // Create kernel
81  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("pixelwise_mul_float", build_opts));
82 
83  // Configure kernel window
84  constexpr unsigned int num_elems_processed_per_iteration = 1;
85 
86  Window win = calculate_max_window(*input1->info(), Steps(num_elems_processed_per_iteration));
87 
88  AccessWindowHorizontal input1_access(input1->info(), 0, num_elems_processed_per_iteration);
89  AccessWindowHorizontal input2_access(input2->info(), 0, num_elems_processed_per_iteration);
90  AccessWindowHorizontal output_access(output->info(), 0, num_elems_processed_per_iteration);
91 
92  update_window_and_padding(win, input1_access, input2_access, output_access);
93 
95  input2->info()->valid_region());
96  output_access.set_valid_region(win, valid_region);
97 
98  IGCKernel::configure(win);
99 }
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
std::string to_string(T &&value)
Convert integer and float values to string.
1 channel, 1 F32 per channel
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES(...)
Definition: Validate.h:441
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: Helpers.h:402
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
ValidRegion intersect_valid_regions(const Ts &... regions)
Intersect multiple valid regions.
Definition: Helpers.h:503
std::unique_ptr< Kernel > create_kernel()
Helper function to create and return a unique_ptr pointed to a CL/GLES kernel object.
Definition: Helpers.h:86
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
bool set_shape_if_empty(ITensorInfo &info, const TensorShape &shape)
Set the shape to the specified value if the current assignment is empty.
Definition: Helpers.inl:234
bool set_format_if_unknown(ITensorInfo &info, Format format)
Set the format, data type and number of channels to the specified value if the current data type is u...
Definition: Helpers.inl:245
Container for valid region of a window.
Definition: Types.h:174
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_MSG(cond,...)
Definition: Error.h:328

References ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES, ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES, ARM_COMPUTE_ERROR_ON_MSG, ARM_COMPUTE_ERROR_ON_NULLPTR, arm_compute::calculate_max_window(), arm_compute::create_kernel(), arm_compute::test::validation::data_type, arm_compute::F32, GCKernelLibrary::get(), ITensor::info(), arm_compute::intersect_valid_regions(), arm_compute::test::validation::scale, arm_compute::set_format_if_unknown(), arm_compute::set_shape_if_empty(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), arm_compute::update_window_and_padding(), arm_compute::test::validation::valid_region, and ITensorInfo::valid_region().

Referenced by GCNormalizationLayer::configure().

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

void run ( const Window window)
overridevirtual

Enqueue the OpenGL ES shader to process the given window.

Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).

Implements IGCKernel.

Definition at line 101 of file GCPixelWiseMultiplicationKernel.cpp.

102 {
105 
106  _kernel.use();
107 
109 
110  do
111  {
112  unsigned int idx = 0;
113  unsigned int binding = 1;
114  add_3D_tensor_argument(idx, _input1, binding++, slice);
115  add_3D_tensor_argument(idx, _input2, binding++, slice);
116  add_3D_tensor_argument(idx, _output, binding++, slice);
117 
118  _kernel.update_shader_params();
119  enqueue(*this, slice);
120  }
122 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void add_3D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.
Definition: IGCKernel.cpp:132
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:39
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:319
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:275
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References IGCKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_3D(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().


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