Compute Library
 21.02
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 45 of file GCPixelWiseMultiplicationKernel.cpp.

46  : _input1(nullptr), _input2(nullptr), _output(nullptr)
47 {
48 }

◆ 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 50 of file GCPixelWiseMultiplicationKernel.cpp.

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(), GCKernelLibrary::create_kernel(), arm_compute::test::validation::data_type, arm_compute::F32, GCKernelLibrary::get(), ITensor::info(), arm_compute::intersect_valid_regions(), num_elems_processed_per_iteration, 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().

51 {
52  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
56  ARM_COMPUTE_ERROR_ON_MSG(scale < 0, "Scale cannot be negative. ");
57 
58  // Auto initialize output if not initialized
59  {
60  set_shape_if_empty(*output->info(), input1->info()->tensor_shape());
62  }
63 
64  ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES(input1, input2, output);
65  ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(input1, input2, output);
66  ARM_COMPUTE_ERROR_ON_MSG(scale < 0, "Scale cannot be negative. ");
67 
68  _input1 = input1;
69  _input2 = input2;
70  _output = output;
71 
72  std::string data_type;
73  std::string compute_type;
74 
75  // Set kernel build options
76  std::set<std::string> build_opts;
77  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(1));
78  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1));
79  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1));
80 
81  build_opts.emplace("#define SCALE " + support::cpp11::to_string(scale));
82 
83  // Create kernel
84  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("pixelwise_mul_float", build_opts));
85 
86  // Configure kernel window
87  constexpr unsigned int num_elems_processed_per_iteration = 1;
88 
89  Window win = calculate_max_window(*input1->info(), Steps(num_elems_processed_per_iteration));
90 
94 
95  update_window_and_padding(win, input1_access, input2_access, output_access);
96 
98  input2->info()->valid_region());
99  output_access.set_valid_region(win, valid_region);
100 
101  IGCKernel::configure(win);
102 }
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...
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
std::string to_string(T &&value)
Convert integer and float values to string.
1 channel, 1 F32 per channel
GCKernel class.
const ValidRegion valid_region
Definition: Scale.cpp:221
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
const DataType data_type
Definition: Im2Col.cpp:150
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
Implementation of a row access pattern.
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES(...)
Definition: Validate.h:441
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
bool set_shape_if_empty(ITensorInfo &info, const TensorShape &shape)
Set the shape to the specified value if the current assignment is empty.
ValidRegion intersect_valid_regions(const Ts &... regions)
Intersect multiple valid regions.
Definition: WindowHelpers.h:74
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
GCKernel create_kernel(const std::string &shader_name, const StringSet &build_options_set={}) const
Creates a kernel from the kernel library.
unsigned int num_elems_processed_per_iteration
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
Container for valid region of a window.
Definition: Types.h:188
Describe a multidimensional execution window.
Definition: Window.h:39

◆ 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 104 of file GCPixelWiseMultiplicationKernel.cpp.

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

105 {
108 
109  _kernel.use();
110 
112 
113  do
114  {
115  unsigned int idx = 0;
116  unsigned int binding = 1;
117  add_3D_tensor_argument(idx, _input1, binding++, slice);
118  add_3D_tensor_argument(idx, _input2, binding++, slice);
119  add_3D_tensor_argument(idx, _output, binding++, slice);
120 
121  _kernel.update_shader_params();
122  enqueue(*this, slice);
123  }
124  while(window.slide_window_slice_3D(slice));
125 }
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&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: IGCKernel.cpp:132
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
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

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