Compute Library
 19.08
NERangeKernel Class Reference

Kernel class for Range. More...

#include <NERangeKernel.h>

Collaboration diagram for NERangeKernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NERangeKernel ()
 Default constructor. More...
 
 NERangeKernel (const NERangeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NERangeKerneloperator= (const NERangeKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NERangeKernel (NERangeKernel &&)=default
 Allow instances of this class to be moved. More...
 
NERangeKerneloperator= (NERangeKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NERangeKernel ()=default
 Default destructor. More...
 
void configure (ITensor *output, float start, float end, float step)
 Initialize the kernel's output tensor, start, end and step of the sequence. 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 *output, float start, float end, float step)
 Static function to check if given info will lead to a valid configuration of NERangeKernel. More...
 

Detailed Description

Kernel class for Range.

range generates a 1-D tensor containing a sequence of numbers that begins at 'start' and extends by increments of 'step' up to but not including 'end'.

Definition at line 39 of file NERangeKernel.h.

Constructor & Destructor Documentation

◆ NERangeKernel() [1/3]

Default constructor.

Definition at line 109 of file NERangeKernel.cpp.

110  : _func(nullptr), _start(0), _end(1), _step(1), _output(nullptr)
111 {
112 }

◆ NERangeKernel() [2/3]

NERangeKernel ( const NERangeKernel )
delete

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

◆ NERangeKernel() [3/3]

NERangeKernel ( NERangeKernel &&  )
default

Allow instances of this class to be moved.

◆ ~NERangeKernel()

~NERangeKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure()

void configure ( ITensor output,
float  start,
float  end,
float  step 
)

Initialize the kernel's output tensor, start, end and step of the sequence.

Parameters
[out]outputOutput tensor. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
[in]startThe starting value of the sequence.
[in]endThe ending (not including) value of the sequence.
[in]stepThe gap between each pair of values in the sequence.

Definition at line 114 of file NERangeKernel.cpp.

115 {
117 
118  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(*(output->info()), start, end, step));
119 
120  // Configure kernel window
121  auto win_config = validate_and_configure_window(*(output->info()), start, end, step);
122  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
123 
124  _start = start;
125  _end = end;
126  _step = step;
127  _output = output;
128  switch(_output->info()->data_type())
129  {
130  case DataType::U8:
131  _func = &range_function<uint8_t>;
132  break;
133  case DataType::U16:
134  _func = &range_function<uint16_t>;
135  break;
136  case DataType::U32:
137  _func = &range_function<uint32_t>;
138  break;
139  case DataType::S8:
140  _func = &range_function<int8_t>;
141  break;
142  case DataType::S16:
143  _func = &range_function<int16_t>;
144  break;
145  case DataType::S32:
146  _func = &range_function<int32_t>;
147  break;
148  case DataType::F32:
149  _func = &range_function<float>;
150  break;
151 #ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
152  case DataType::F16:
153  _func = &range_function<float16_t>;
154  break;
155 #endif // __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
156  default:
157  ARM_COMPUTE_ERROR("Unsupported data type.");
158  break;
159  }
160 
161  INEKernel::configure(win_config.second);
162 }
#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)
1 channel, 1 U8 per channel
virtual DataType data_type() const =0
Data type used for each element of the tensor.
1 channel, 1 F32 per channel
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
1 channel, 1 U16 per channel
1 channel, 1 F16 per channel
1 channel, 1 S32 per channel
1 channel, 1 U32 per channel
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
signed 8-bit number

References ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, ITensorInfo::data_type(), arm_compute::F16, arm_compute::F32, ITensor::info(), arm_compute::S16, arm_compute::S32, arm_compute::S8, arm_compute::test::validation::step, arm_compute::U16, arm_compute::U32, arm_compute::U8, and arm_compute::validate_and_configure_window().

Referenced by NERange::configure().

◆ name()

const char* name ( ) const
inlineoverridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 42 of file NERangeKernel.h.

43  {
44  return "NERangeKernel";
45  }

◆ operator=() [1/2]

NERangeKernel& operator= ( const NERangeKernel )
delete

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

◆ operator=() [2/2]

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

175 {
179  ARM_COMPUTE_ERROR_ON(_func == nullptr);
180 
181  (*_func)(_output, _start, _step, window);
182 }
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:337
#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, 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 output,
float  start,
float  end,
float  step 
)
static

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

Parameters
[in]outputOutput tensor info. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
[in]startThe starting value of the sequence.
[in]endThe ending (not including) value of the sequence.
[in]stepThe gap between each pair of values in the sequence.
Returns
a status

Definition at line 164 of file NERangeKernel.cpp.

165 {
167 
168  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(*output, start, end, step));
169  ARM_COMPUTE_RETURN_ON_ERROR((validate_and_configure_window(*(output->clone()), start, end, step)).first);
170 
171  return Status{};
172 }
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
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:163

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), arm_compute::test::validation::step, and arm_compute::validate_and_configure_window().

Referenced by NERange::validate().


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