Compute Library
 21.02
GCArithmeticAdditionKernel Class Reference

Interface for the arithmetic addition kernel. More...

#include <GCArithmeticAdditionKernel.h>

Collaboration diagram for GCArithmeticAdditionKernel:
[legend]

Public Member Functions

 GCArithmeticAdditionKernel ()
 Default constructor. More...
 
 GCArithmeticAdditionKernel (const GCArithmeticAdditionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
GCArithmeticAdditionKerneloperator= (const GCArithmeticAdditionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 GCArithmeticAdditionKernel (GCArithmeticAdditionKernel &&)=default
 Allow instances of this class to be moved. More...
 
GCArithmeticAdditionKerneloperator= (GCArithmeticAdditionKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~GCArithmeticAdditionKernel ()=default
 Default destructor. More...
 
void configure (const IGCTensor *input1, const IGCTensor *input2, IGCTensor *output, ConvertPolicy policy)
 Initialise the kernel's inputs, output and convertion policy. 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...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ConvertPolicy policy)
 Static function to check if given info will lead to a valid configuration of GCArithmeticAdditionKernel. More...
 

Detailed Description

Interface for the arithmetic addition kernel.

Arithmetic addition is computed by:

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

Definition at line 39 of file GCArithmeticAdditionKernel.h.

Constructor & Destructor Documentation

◆ GCArithmeticAdditionKernel() [1/3]

Default constructor.

Definition at line 89 of file GCArithmeticAdditionKernel.cpp.

90  : _input1(nullptr), _input2(nullptr), _output(nullptr)
91 {
92 }

◆ GCArithmeticAdditionKernel() [2/3]

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

◆ GCArithmeticAdditionKernel() [3/3]

Allow instances of this class to be moved.

◆ ~GCArithmeticAdditionKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const IGCTensor input1,
const IGCTensor input2,
IGCTensor output,
ConvertPolicy  policy 
)

Initialise the kernel's inputs, output and convertion policy.

Parameters
[in]input1First tensor input. Data types supported: F16.
[in]input2Second tensor input. Data types supported: F16.
[out]outputOutput tensor. Data types supported: F16.
[in]policyPolicy to use to handle overflow.

Definition at line 94 of file GCArithmeticAdditionKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ARM_COMPUTE_UNUSED, GCKernelLibrary::create_kernel(), arm_compute::F16, GCKernelLibrary::get(), ITensor::info(), arm_compute::set_format_if_unknown(), arm_compute::set_shape_if_empty(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), and arm_compute::validate_arguments().

95 {
96  ARM_COMPUTE_UNUSED(policy);
97  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
98 
99  // Auto initialize output if not initialized
100  {
101  set_shape_if_empty(*output->info(), input1->info()->tensor_shape());
103  }
104 
105  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input1->info(), input2->info(), output->info(), policy));
106 
107  _input1 = input1;
108  _input2 = input2;
109  _output = output;
110 
111  // Set kernel build options
112  std::set<std::string> build_opts;
113  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(1));
114  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1));
115  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1));
116 
117  // Create kernel
118  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("arithmetic_add", build_opts));
119 
120  // Configure kernel window
121  auto win_config = validate_and_configure_window(input1->info(), input2->info(), output->info());
122  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
123  IGCKernel::configure(win_config.second);
124 }
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...
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
GCKernel class.
1 channel, 1 F16 per channel
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
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.
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
GCKernel create_kernel(const std::string &shader_name, const StringSet &build_options_set={}) const
Creates a kernel from the kernel library.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

◆ operator=() [1/2]

GCArithmeticAdditionKernel& operator= ( const GCArithmeticAdditionKernel )
delete

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 134 of file GCArithmeticAdditionKernel.cpp.

References IGCKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::DimX, arm_compute::enqueue(), Window::first_slice_window_3D(), ITensor::info(), ITensorInfo::padding(), IGCTensor::set_needs_shifting(), Window::shift(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

135 {
138 
139  _kernel.use();
140 
141  _output->set_needs_shifting(true);
142 
144  Window slice_in = window.first_slice_window_3D();
145 
146  slice.shift(Window::DimX, -(_output->info()->padding()).left);
147 
148  do
149  {
150  unsigned int idx = 0;
151  unsigned int binding = 1; // SSBO binding starts from 1.
152  add_3D_tensor_argument(idx, _input1, binding++, slice_in);
153  add_3D_tensor_argument(idx, _input2, binding++, slice_in);
154  add_3D_tensor_argument(idx, _output, binding++, slice);
155 
156  _kernel.update_shader_params();
157 
158  enqueue(*this, slice);
159  }
160  while(window.slide_window_slice_3D(slice) && window.slide_window_slice_3D(slice_in));
161 }
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
void shift(size_t dimension, int shift_value)
Shift the values of a given dimension by the given shift_value.
Definition: Window.inl:133
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
void set_needs_shifting(bool needs_shifting)
Set the flag indicating whether or not a tensor needs shifting.
Definition: IGCTensor.cpp:61
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
virtual PaddingSize padding() const =0
Padding of tensor.
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)

◆ validate()

Status validate ( const ITensorInfo input1,
const ITensorInfo input2,
const ITensorInfo output,
ConvertPolicy  policy 
)
static

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

Parameters
[in]input1First tensor input info. Data types supported: F16.
[in]input2Second tensor input info. Data types supported: F16.
[out]outputOutput tensor info. Data types supported: F16.
[in]policyPolicy to use to handle overflow.
Returns
a status

Definition at line 126 of file GCArithmeticAdditionKernel.cpp.

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

Referenced by GCArithmeticAddition::validate().

127 {
128  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input1, input2, output, policy));
129  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input1->clone().get(), input2->clone().get(), output->clone().get()).first);
130 
131  return Status{};
132 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status class.
Definition: Error.h:52
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)

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