Compute Library
 21.02
NETransposeKernel Class Reference

Neon kernel which transposes the elements of a matrix. More...

#include <NETransposeKernel.h>

Collaboration diagram for NETransposeKernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NETransposeKernel ()
 Default constructor. More...
 
 NETransposeKernel (const NETransposeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NETransposeKerneloperator= (const NETransposeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NETransposeKernel (NETransposeKernel &&)=default
 Allow instances of this class to be moved. More...
 
NETransposeKerneloperator= (NETransposeKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NETransposeKernel ()=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 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 NETransposeKernel. More...
 

Detailed Description

Neon kernel which transposes the elements of a matrix.

[width, height, batch] -> [height, width, batch]

Definition at line 38 of file NETransposeKernel.h.

Constructor & Destructor Documentation

◆ NETransposeKernel() [1/3]

Default constructor.

Definition at line 464 of file NETransposeKernel.cpp.

Referenced by NETransposeKernel::name().

465  : _func(nullptr), _input(nullptr), _output(nullptr)
466 {
467 }

◆ NETransposeKernel() [2/3]

NETransposeKernel ( const NETransposeKernel )
delete

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

◆ NETransposeKernel() [3/3]

Allow instances of this class to be moved.

◆ ~NETransposeKernel()

~NETransposeKernel ( )
default

Default destructor.

Referenced by NETransposeKernel::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. Data type supported: Same as input

Definition at line 469 of file NETransposeKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), ICloneable< T >::clone(), ITensor::info(), arm_compute::test::validation::input, ITensorInfo::tensor_shape(), and arm_compute::validate_arguments().

Referenced by NETransposeKernel::name().

470 {
471  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
472 
473  // Output tensor auto inizialitation if not yet initialized
474  auto_init_if_empty(*output->info(), input->info()->clone()->set_tensor_shape(transposed_tensor_shape(input->info()->tensor_shape())));
475 
477 
478  _input = input;
479  _output = output;
480 
481  switch(input->info()->element_size())
482  {
483  case 1:
484  _func = &transpose_8bit_elements;
485  break;
486  case 2:
487  _func = &transpose_16bit_elements;
488  break;
489  case 4:
490  _func = &transpose_32bit_elements;
491  break;
492  default:
493  ARM_COMPUTE_ERROR("Element size not supported");
494  break;
495  }
496 
497  // Configure kernel window
498  Coordinates coord;
499  coord.set_num_dimensions(output->info()->num_dimensions());
500  output->info()->set_valid_region(ValidRegion(coord, output->info()->tensor_shape()));
501 
502  // Note: This kernel performs 16 elements per iteration.
503  // However, since we use a left-over for loop on both dimensions (X and Y), we cannot have any read or write out of memory
504  // For this reason num_elems_processed_per_iteration_x is set to 1
505  const unsigned int num_elems_processed_per_iteration_x = 1;
506  const unsigned int num_elems_processed_per_iteration_y = num_elems_processed(input->info()->element_size());
507 
508  // Configure kernel window
509  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
510 
511  INEKernel::configure(win);
512 }
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(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
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]

NETransposeKernel& operator= ( const NETransposeKernel )
delete

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

Referenced by NETransposeKernel::name().

◆ operator=() [2/2]

NETransposeKernel& operator= ( NETransposeKernel &&  )
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.

Reimplemented from ICPPKernel.

Definition at line 514 of file NETransposeKernel.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 NETransposeKernel::name().

515 {
516  ARM_COMPUTE_UNUSED(info);
519  ARM_COMPUTE_ERROR_ON(_func == nullptr);
520 
521  (*_func)(_input, _output, window);
522 }
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 NETransposeKernel.

Parameters
[in]inputInput tensor. Data types supported: All
[in]outputOutput tensor. Data type supported: Same as input
Returns
a status

Definition at line 457 of file NETransposeKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::validate_arguments().

Referenced by NETransposeKernel::name(), NETranspose::validate(), and NEFullyConnectedLayerReshapeWeights::validate().

458 {
459  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
461  return Status{};
462 }
#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)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

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