Compute Library
 20.02.1
CLStackLayerKernel Class Reference

OpenCL kernel to stacks a rank-R tensor into one with rank-(R+1) along the axis dimension. More...

#include <CLStackLayerKernel.h>

Collaboration diagram for CLStackLayerKernel:
[legend]

Public Member Functions

 CLStackLayerKernel ()
 Default constructor. More...
 
 CLStackLayerKernel (const CLStackLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLStackLayerKerneloperator= (const CLStackLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLStackLayerKernel (CLStackLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLStackLayerKerneloperator= (CLStackLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLStackLayerKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, ICLTensor *output)
 Initialise the kernel's inputs 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, unsigned int axis, unsigned int idx_input, unsigned int num_tensors, const ITensorInfo *output)
 Static function to check if given info will lead to a valid configuration of CLStackLayerKernel. 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

OpenCL kernel to stacks a rank-R tensor into one with rank-(R+1) along the axis dimension.

Definition at line 36 of file CLStackLayerKernel.h.

Constructor & Destructor Documentation

◆ CLStackLayerKernel() [1/3]

Default constructor.

Definition at line 78 of file CLStackLayerKernel.cpp.

79  : _input(nullptr), _output(nullptr)
80 {
81 }

◆ CLStackLayerKernel() [2/3]

CLStackLayerKernel ( const CLStackLayerKernel )
delete

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

◆ CLStackLayerKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLStackLayerKernel()

~CLStackLayerKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
unsigned int  axis,
unsigned int  idx_input,
unsigned int  num_tensors,
ICLTensor output 
)

Initialise the kernel's inputs and output.

Note
Supported input tensor rank: up to 4
Parameters
[in]inputInput tensor. Data types supported: All.
[in]axisThe dimension to stack the tensors along. It must be smaller than the number of input dimensions.
[in]idx_inputIndex of the input tensor in the list of tensors to stack. All tensors in the list must have the same shape
[in]num_tensorsNumber of tensors to stack
[out]outputOutput tensor. Data types supported: Same as input.

Definition at line 83 of file CLStackLayerKernel.cpp.

84 {
86  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), axis, idx_input, num_tensors, output->info()));
87 
88  _input = input;
89  _output = output;
90 
91  // Configure kernel window
92  auto win_config = validate_and_configure_window(input->info(), axis, num_tensors, output->info());
93 
94  // Add build options
95  CLBuildOptions build_opts;
96  build_opts.add_option("-DDATA_TYPE=" + get_underlying_cl_type_from_data_type(input->info()->data_type()));
97  build_opts.add_option("-DAXIS=" + support::cpp11::to_string(axis));
98  build_opts.add_option("-DSRC_DIM2=" + support::cpp11::to_string(input->info()->dimension(2)));
99  build_opts.add_option("-DDST_DIM3=" + support::cpp11::to_string(output->info()->dimension(3)));
100 
101  // Create kernel
102  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel("stack_layer", build_opts.options()));
103 
104  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
105  ICLKernel::configure_internal(win_config.second);
106 
107  const unsigned int idx = 2 * num_arguments_per_4D_tensor();
108  _kernel.setArg<cl_uint>(idx, idx_input);
109 }
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:455
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
std::string get_underlying_cl_type_from_data_type(const DataType &dt)
Translates fixed point tensor data type to the underlying OpenCL type.
Definition: CLHelpers.cpp:221
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::test::validation::axis, arm_compute::create_kernel(), ITensorInfo::dimension(), CLKernelLibrary::get(), arm_compute::get_underlying_cl_type_from_data_type(), ITensor::info(), arm_compute::test::validation::input, ICLKernel::num_arguments_per_4D_tensor(), arm_compute::test::validation::num_tensors, and arm_compute::support::cpp11::to_string().

◆ operator=() [1/2]

CLStackLayerKernel& operator= ( const CLStackLayerKernel )
delete

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

◆ operator=() [2/2]

CLStackLayerKernel& operator= ( CLStackLayerKernel &&  )
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 118 of file CLStackLayerKernel.cpp.

119 {
122 
123  Window window_out;
124  window_out.use_tensor_dimensions(_output->info()->tensor_shape());
125 
126  Window collapsed = window.collapse(ICLKernel::window(), Window::DimZ);
127 
128  Window slice_in = collapsed.first_slice_window_4D();
129  Window slice_out = window_out.first_slice_window_4D();
130 
131  unsigned int idx = 0;
132  add_4D_tensor_argument(idx, _input, slice_in);
133  add_4D_tensor_argument(idx, _output, slice_out);
134  enqueue(queue, *this, slice_in, lws_hint());
135 }
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:111
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's metadata.
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
Window first_slice_window_4D() const
First 4D slice of the window.
Definition: Window.h:297
#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:941

References 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_4D(), ITensor::info(), ICLKernel::lws_hint(), ITensorInfo::tensor_shape(), Window::use_tensor_dimensions(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
unsigned int  axis,
unsigned int  idx_input,
unsigned int  num_tensors,
const ITensorInfo output 
)
static

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

Note
Supported input tensor rank: up to 4
Parameters
[in]inputInput tensor info. Data types supported: All.
[in]axisThe dimension to stack the tensors along. It must be smaller than the number of input dimensions.
[in]idx_inputIndex of the input tensor in the list of tensors to stack All tensors in the list must have the same shape
[in]num_tensorsNumber of tensors to stack
[in]outputOutput tensor info. Data types supported: Same as input.
Returns
a status

Definition at line 111 of file CLStackLayerKernel.cpp.

112 {
113  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, axis, idx_input, num_tensors, output));
114  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), axis, num_tensors, output->clone().get()).first);
115  return Status{};
116 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204

References ARM_COMPUTE_RETURN_ON_ERROR, arm_compute::test::validation::axis, ICloneable< T >::clone(), arm_compute::test::validation::input, and arm_compute::test::validation::num_tensors.

Referenced by CLStackLayer::validate().


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