Compute Library
 21.02
NEGEMMInterleave4x4Kernel Class Reference

Neon kernel to interleave the elements of a matrix. More...

#include <NEGEMMInterleave4x4Kernel.h>

Collaboration diagram for NEGEMMInterleave4x4Kernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NEGEMMInterleave4x4Kernel ()
 Constructor. More...
 
 NEGEMMInterleave4x4Kernel (const NEGEMMInterleave4x4Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NEGEMMInterleave4x4Kerneloperator= (const NEGEMMInterleave4x4Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NEGEMMInterleave4x4Kernel (NEGEMMInterleave4x4Kernel &&)=default
 Allow instances of this class to be moved. More...
 
NEGEMMInterleave4x4Kerneloperator= (NEGEMMInterleave4x4Kernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NEGEMMInterleave4x4Kernel ()=default
 Default destructor. More...
 
void configure (const ITensor *input, ITensor *output)
 Initialise the kernel's input and output. More...
 
void run (const Window &window, const ThreadInfo &info) override
 Execute the kernel on the passed window. More...
 
- Public Member Functions inherited from ICPPSimpleKernel
 ICPPSimpleKernel ()
 Constructor. More...
 
 ICPPSimpleKernel (const ICPPSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICPPSimpleKerneloperator= (const ICPPSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICPPSimpleKernel (ICPPSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICPPSimpleKerneloperator= (ICPPSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~ICPPSimpleKernel ()=default
 Default destructor. More...
 
- Public Member Functions inherited from ICPPKernel
virtual ~ICPPKernel ()=default
 Default destructor. More...
 
virtual void run_nd (const Window &window, const ThreadInfo &info, const Window &thread_locator)
 legacy compatibility layer for implemantions which do not support thread_locator In these cases we simply narrow the interface down the legacy version More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, const ThreadInfo &info)
 Execute the kernel on the passed window. 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)
 Static function to check if given info will lead to a valid configuration of NEGEMMInterleave4x4Kernel. More...
 

Detailed Description

Neon kernel to interleave the elements of a matrix.

This function puts the values in a 4x4 block of Matrix A on the same row (Interleaved values)

\[ \left( \begin{array}{cccc} a00 & a01 & a02 & a03 \\ a10 & a11 & a12 & a13 \\ a20 & a21 & a22 & a23 \\ a30 & a31 & a32 & a33 \\ \end{array} \right) \rightarrow \left( \begin{array}{ccccccccccccccccc} a00 & a10 & a20 & a30 & a01 & a11 & a21 & a31 & a02 & a12 & a22 & a32 & a03 & a13 & a23 & a33 \\ \end{array} \right) \]

After this operation, the output matrix will have the following shape: [ height * 4, ceil(width / 4.0f) ]

Definition at line 52 of file NEGEMMInterleave4x4Kernel.h.

Constructor & Destructor Documentation

◆ NEGEMMInterleave4x4Kernel() [1/3]

Constructor.

Definition at line 68 of file NEGEMMInterleave4x4Kernel.cpp.

Referenced by NEGEMMInterleave4x4Kernel::name().

69  : _func(nullptr)
70 {
71 }

◆ NEGEMMInterleave4x4Kernel() [2/3]

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

◆ NEGEMMInterleave4x4Kernel() [3/3]

Allow instances of this class to be moved.

◆ ~NEGEMMInterleave4x4Kernel()

Default destructor.

Referenced by NEGEMMInterleave4x4Kernel::name().

Member Function Documentation

◆ configure()

void configure ( const ITensor input,
ITensor output 
)

Initialise the kernel's input and output.

Parameters
[in]inputInput tensor. Data types supported: All
[out]outputOutput tensor which stores the interleaved matrix. Data type supported: same as input.

Definition at line 73 of file NEGEMMInterleave4x4Kernel.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), ICloneable< T >::clone(), arm_compute::misc::shape_calculator::compute_interleaved_shape(), ITensorInfo::element_size(), ITensor::info(), arm_compute::test::validation::input, ITensorInfo::num_dimensions(), Dimensions< T >::set_num_dimensions(), ITensorInfo::set_valid_region(), ITensorInfo::tensor_shape(), and arm_compute::validate_arguments().

Referenced by NEGEMMInterleave4x4Kernel::name().

74 {
75  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
76 
77  // Output auto inizialitation if not yet initialized
78  auto_init_if_empty(*output->info(), input->info()->clone()->set_tensor_shape(compute_interleaved_shape(*input->info())));
79 
80  // Perform validate step
82 
83  _input = input;
84  _output = output;
85 
86  switch(input->info()->element_size())
87  {
88  case 1:
89  _func = &NEGEMMInterleave4x4Kernel::gemm_interleave4x4<uint8_t>;
90  break;
91  case 2:
92  _func = &NEGEMMInterleave4x4Kernel::gemm_interleave4x4<uint16_t>;
93  break;
94  case 4:
95  _func = &NEGEMMInterleave4x4Kernel::gemm_interleave4x4<uint32_t>;
96  break;
97  default:
98  ARM_COMPUTE_ERROR_ON("Element size not supported");
99  break;
100  }
101 
102  Window win = calculate_max_window(*input->info(), Steps(1, 4));
103 
104  Coordinates coord;
105  coord.set_num_dimensions(output->info()->num_dimensions());
106  output->info()->set_valid_region(ValidRegion(coord, output->info()->tensor_shape()));
107 
108  INEKernel::configure(win);
109 }
virtual size_t num_dimensions() const =0
The number of dimensions of the tensor (rank)
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
TensorShape compute_interleaved_shape(const ITensorInfo &a, int mult_interleave4x4_height=1, bool reinterpret_input_as_3d=false)
Calculate the interleaved shape of an input tensor.
virtual void set_valid_region(const ValidRegion &valid_region)=0
Set the valid region of the tensor.
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Coordinates of an item.
Definition: Coordinates.h:37
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...
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
virtual size_t element_size() const =0
Element size in bytes calculated as data_size() * num_channels()
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
void set_num_dimensions(size_t num_dimensions)
Set number of dimensions.
Definition: Dimensions.h:149
Container for valid region of a window.
Definition: Types.h:188
Describe a multidimensional execution window.
Definition: Window.h:39

◆ name()

◆ operator=() [1/2]

NEGEMMInterleave4x4Kernel& operator= ( const NEGEMMInterleave4x4Kernel )
delete

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

Referenced by NEGEMMInterleave4x4Kernel::name().

◆ operator=() [2/2]

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.

Reimplemented from ICPPKernel.

Definition at line 175 of file NEGEMMInterleave4x4Kernel.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, and IKernel::window().

Referenced by NEGEMMInterleave4x4Kernel::name().

176 {
177  ARM_COMPUTE_UNUSED(info);
180  ARM_COMPUTE_ERROR_ON(_func == nullptr);
181  /*
182  * This kernel puts the values in a 4x4 block of Matrix A on the same row (Interleaved values)
183  * |a00 a01 a02 a03|
184  * |a10 a11 a12 a13|
185  * |a20 a21 a22 a23| = | a00 a10 a20 a30 || a01 a11 a21 a31 || a02 a12 a22 a32 || a03 a13 a23 a33 |
186  * |a30 a31 a32 a33|
187  *
188  * After this operation, the output matrix will have the following shape: [ height * 4, ceil(width / 4.0f) ]
189  */
190  (this->*_func)(_input, _output, window);
191 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205

◆ validate()

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

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

Parameters
[in]inputInput tensor info. Data types supported: All
[in]outputOutput tensor info which stores the interleaved matrix. Data type supported: same as input.
Returns
a status

Definition at line 111 of file NEGEMMInterleave4x4Kernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, ITensorInfo::dimension(), Window::DimX, Window::DimY, Window::Dimension::end(), arm_compute::execute_window_loop(), ITensor::info(), Iterator::ptr(), Window::scale(), Window::set(), Window::Dimension::start(), ITensorInfo::strides_in_bytes(), arm_compute::validate_arguments(), IKernel::window(), and Window::x().

Referenced by NEGEMMInterleave4x4Kernel::name(), NEGEMM::validate(), and NEGEMMLowpMatrixMultiplyCore::validate().

112 {
114 
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
Status class.
Definition: Error.h:52
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: