Compute Library
 19.08
NECol2ImKernel Class Reference

NEON kernel to perform col2im reshaping. More...

#include <NECol2ImKernel.h>

Collaboration diagram for NECol2ImKernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NECol2ImKernel ()
 Default constructor. More...
 
 NECol2ImKernel (const NECol2ImKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NECol2ImKerneloperator= (const NECol2ImKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NECol2ImKernel (NECol2ImKernel &&)=default
 Allow instances of this class to be moved. More...
 
NECol2ImKerneloperator= (NECol2ImKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NECol2ImKernel ()=default
 Default destructor. More...
 
void configure (const ITensor *input, ITensor *output, const Size2D &convolved_dims)
 Set the input and output of the kernel. More...
 
void run (const Window &window, const ThreadInfo &info) override
 Execute the kernel on the passed window. More...
 
- Public Member Functions inherited from ICPPKernel
virtual ~ICPPKernel ()=default
 Default destructor. 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 *input, const ITensorInfo *output, const Size2D &convolved_dims)
 Static function to check if given info will lead to a valid configuration of NECol2ImKernel. More...
 

Detailed Description

NEON kernel to perform col2im reshaping.

Rearranges each matrix column into image blocks. It's the inverse operation of NEIm2ColKernel.

For example, a vector of 9 elements can be reshaped to a block(image) of 3x3:

\[ \left( \begin{array}{ccccccccc} a0 & a1 & a2 & a3 & a4 & a5 & a6 & a7 & a8 \\ \end{array} \right) \rightarrow \left( \begin{array}{ccc} a0 & a1 & a2 \\ a3 & a4 & a5 \\ a6 & a7 & a8 \\ \end{array} \right) \]

Definition at line 53 of file NECol2ImKernel.h.

Constructor & Destructor Documentation

◆ NECol2ImKernel() [1/3]

Default constructor.

Definition at line 105 of file NECol2ImKernel.cpp.

106  : _func(), _input(nullptr), _output(nullptr), _convolved_dims()
107 {
108 }

◆ NECol2ImKernel() [2/3]

NECol2ImKernel ( const NECol2ImKernel )
delete

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

◆ NECol2ImKernel() [3/3]

NECol2ImKernel ( NECol2ImKernel &&  )
default

Allow instances of this class to be moved.

◆ ~NECol2ImKernel()

~NECol2ImKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ITensor input,
ITensor output,
const Size2D convolved_dims 
)

Set the input and output of the kernel.

Parameters
[in]inputThe input tensor to convert. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[out]outputThe output tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. Data types supported: Same as input
[in]convolved_dimsOutput convolved dimensions.

Definition at line 110 of file NECol2ImKernel.cpp.

111 {
112  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
113  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), convolved_dims));
114 
115  _input = input;
116  _output = output;
117  _convolved_dims = convolved_dims;
118 
119  switch(input->info()->element_size())
120  {
121  case 1:
122  _func = &NECol2ImKernel::run_col2im<uint8_t>;
123  break;
124  case 2:
125  _func = &NECol2ImKernel::run_col2im<uint16_t>;
126  break;
127  case 4:
128  _func = &NECol2ImKernel::run_col2im<uint32_t>;
129  break;
130  default:
131  ARM_COMPUTE_ERROR("Element size not supported");
132  break;
133  }
134 
135  // Configure kernel window
136  auto win_config = validate_and_configure_window(input->info(), output->info(), convolved_dims);
137  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
138  INEKernel::configure(win_config.second);
139 }
#define ARM_COMPUTE_ERROR(...)
Print the given message then throw an std::runtime_error.
Definition: Error.h:261
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
virtual size_t element_size() const =0
Element size in bytes calculated as data_size() * num_channels()
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

References ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ITensorInfo::element_size(), ITensor::info(), and arm_compute::validate_and_configure_window().

Referenced by NELocallyConnectedLayer::configure(), and NEGEMMConvolutionLayer::configure().

◆ name()

const char* name ( ) const
inlineoverridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 56 of file NECol2ImKernel.h.

57  {
58  return "NECol2ImKernel";
59  }

◆ operator=() [1/2]

NECol2ImKernel& operator= ( const NECol2ImKernel )
delete

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

◆ operator=() [2/2]

NECol2ImKernel& operator= ( NECol2ImKernel &&  )
default

Allow instances of this class to be moved.

◆ run()

void run ( const Window window,
const ThreadInfo info 
)
overridevirtual

Execute the kernel on the passed window.

Warning
If is_parallelisable() returns false then the passed window must be equal to window()
Note
The window has to be a region within the window returned by the window() method
The width of the window has to be a multiple of num_elems_processed_per_iteration().
Parameters
[in]windowRegion on which to execute the kernel. (Must be a region of the window returned by window())
[in]infoInfo about executing thread and CPU.

Implements ICPPKernel.

Definition at line 148 of file NECol2ImKernel.cpp.

149 {
153 
154  (this->*_func)(window);
155 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:160
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940

References ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, arm_compute::test::validation::info, and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const Size2D convolved_dims 
)
static

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

Parameters
[in]inputThe input tensor to convert. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]outputThe output tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. Data types supported: Same as input
[in]convolved_dimsOutput convolved dimensions.
Returns
a status

Definition at line 141 of file NECol2ImKernel.cpp.

142 {
143  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, convolved_dims));
144  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get(), convolved_dims).first);
145  return Status{};
146 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:193
Status class.
Definition: Error.h:52
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.

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

Referenced by NECol2Im::validate(), NELocallyConnectedLayer::validate(), and NEGEMMConvolutionLayer::validate().


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