Compute Library
 19.08
CLReverseKernel Class Reference

Interface for the reverse kernel. More...

#include <CLReverseKernel.h>

Collaboration diagram for CLReverseKernel:
[legend]

Public Member Functions

 CLReverseKernel ()
 Default constructor. More...
 
 CLReverseKernel (const CLReverseKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLReverseKerneloperator= (const CLReverseKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLReverseKernel (CLReverseKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLReverseKerneloperator= (CLReverseKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLReverseKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const ICLTensor *axis)
 Initialise the kernel's inputis and output. 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...
 
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...
 
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...
 
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<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...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
- 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 *input, const ITensorInfo *output, const ITensorInfo *axis)
 Static function to check if given info will lead to a valid configuration of CLReverseKernel. 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...
 

Data Fields

const ICLTensor_input
 
ICLTensor_output
 
const ICLTensor_axis
 

Detailed Description

Interface for the reverse kernel.

Definition at line 34 of file CLReverseKernel.h.

Constructor & Destructor Documentation

◆ CLReverseKernel() [1/3]

Default constructor.

Definition at line 63 of file CLReverseKernel.cpp.

64  : _input(nullptr), _output(nullptr), _axis(nullptr)
65 {
66 }

◆ CLReverseKernel() [2/3]

CLReverseKernel ( const CLReverseKernel )
delete

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

◆ CLReverseKernel() [3/3]

CLReverseKernel ( CLReverseKernel &&  )
default

Allow instances of this class to be moved.

◆ ~CLReverseKernel()

~CLReverseKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output,
const ICLTensor axis 
)

Initialise the kernel's inputis and output.

Parameters
[in]inputInput tensor. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[out]outputOutput tensor. Data type supported: Same as input
[in]axisAxis tensor. Contains the indices of the dimensions to reverse. Data type supported: U32

Definition at line 68 of file CLReverseKernel.cpp.

69 {
70  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, axis);
71 
72  _input = input;
73  _output = output;
74  _axis = axis;
75 
76  // Output tensor auto initialization if not yet initialized
77  auto_init_if_empty(*output->info(), *input->info()->clone());
78 
79  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), axis->info()));
80 
81  // Set kernel build options
82  CLBuildOptions build_opts;
83  build_opts.add_option("-DNUM_REVERSE_DIMS=" + support::cpp11::to_string(axis->info()->dimension(0)));
84  switch(input->info()->element_size())
85  {
86  case 1:
87  build_opts.add_option("-DDATA_TYPE=uchar");
88  break;
89  case 2:
90  build_opts.add_option("-DDATA_TYPE=ushort");
91  break;
92  case 4:
93  build_opts.add_option("-DDATA_TYPE=uint");
94  break;
95  default:
96  ARM_COMPUTE_ERROR("Data type not supported");
97  }
98 
99  // Create kernel
100  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel("reverse", build_opts.options()));
101 
102  // Set static kernel arguments
103  unsigned int idx = 2 * num_arguments_per_4D_tensor() + num_arguments_per_1D_tensor();
104  add_argument<cl_uint>(idx, input->info()->dimension(0));
105  add_argument<cl_uint>(idx, input->info()->dimension(1));
106  add_argument<cl_uint>(idx, input->info()->dimension(2));
107  add_argument<cl_uint>(idx, input->info()->dimension(3));
108 
109  // Configure kernel window
110  Window win = calculate_max_window(*output->info(), Steps());
111  ICLKernel::configure_internal(win);
112 
113  // Set config_id for enabling LWS tuning
114  _config_id += "reverse_";
115  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
116  _config_id += "_";
117  _config_id += support::cpp11::to_string(input->info()->dimension(0));
118  _config_id += "_";
119  _config_id += support::cpp11::to_string(input->info()->dimension(1));
120  _config_id += "_";
121  _config_id += support::cpp11::to_string(input->info()->dimension(2));
122 }
static constexpr unsigned int num_arguments_per_1D_tensor()
Returns the number of arguments enqueued per 1D tensor object.
Definition: ICLKernel.h:184
#define ARM_COMPUTE_ERROR(...)
Print the given message then throw an std::runtime_error.
Definition: Error.h:261
std::string to_string(T &&value)
Convert integer and float values to string.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
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
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
Definition: Helpers.inl:201
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
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
static constexpr unsigned int num_arguments_per_4D_tensor()
Returns the number of arguments enqueued per 4D tensor object.
Definition: ICLKernel.h:208
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

References CLReverseKernel::_axis, CLReverseKernel::_input, CLReverseKernel::_output, CLBuildOptions::add_option(), ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::test::validation::axis, arm_compute::calculate_max_window(), ICloneable< T >::clone(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), CLKernelLibrary::get(), ITensor::info(), arm_compute::lower_string(), ICLKernel::num_arguments_per_1D_tensor(), ICLKernel::num_arguments_per_4D_tensor(), CLBuildOptions::options(), arm_compute::string_from_data_type(), and arm_compute::support::cpp11::to_string().

◆ operator=() [1/2]

CLReverseKernel& operator= ( const CLReverseKernel )
delete

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

◆ operator=() [2/2]

CLReverseKernel& operator= ( CLReverseKernel &&  )
default

Allow instances of this class to be moved.

◆ 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]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.

Implements ICLKernel.

Definition at line 130 of file CLReverseKernel.cpp.

131 {
134 
135  Window collapsed = window.collapse(ICLKernel::window(), Window::DimZ);
136  Window slice = collapsed.first_slice_window_4D();
137  Window axis_slice = collapsed.first_slice_window_1D();
138 
139  do
140  {
141  unsigned int idx = 0;
143  add_1D_tensor_argument(idx, _axis, axis_slice);
145  enqueue(queue, *this, slice, lws_hint());
146  }
147  while(collapsed.slide_window_slice_4D(slice));
148 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:247
Window collapse(const Window &full_window, size_t first, size_t last=Coordinates::num_max_dimensions) const
Collapse the dimensions between first and last.
Definition: Window.inl:97
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
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.
Definition: ICLKernel.h:110
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
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.
Definition: ICLKernel.h:168
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References CLReverseKernel::_axis, CLReverseKernel::_input, CLReverseKernel::_output, ICLKernel::add_1D_tensor_argument(), ICLKernel::add_4D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse(), Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_1D(), Window::first_slice_window_4D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_4D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const ITensorInfo axis 
)
static

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

Parameters
[in]inputInput tensor info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]outputOutput tensor info. Data type supported: Same as input
[in]axisAxis tensor info. Contains the indices of the dimensions to reverse. Data type supported: U32
Returns
a status

Definition at line 124 of file CLReverseKernel.cpp.

125 {
126  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, axis));
127  return Status{};
128 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:193

References ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::test::validation::axis.

Referenced by CLReverse::validate().

Field Documentation

◆ _axis

const ICLTensor* _axis

Definition at line 73 of file CLReverseKernel.h.

Referenced by CLReverseKernel::configure(), and CLReverseKernel::run().

◆ _input

const ICLTensor* _input

Definition at line 71 of file CLReverseKernel.h.

Referenced by CLReverseKernel::configure(), and CLReverseKernel::run().

◆ _output

ICLTensor* _output

Definition at line 72 of file CLReverseKernel.h.

Referenced by CLReverseKernel::configure(), and CLReverseKernel::run().


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