Compute Library
 21.02
NEThresholdKernel Class Reference

Interface for the thresholding kernel. More...

#include <NEThresholdKernel.h>

Collaboration diagram for NEThresholdKernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NEThresholdKernel ()
 Default constructor. More...
 
 NEThresholdKernel (const NEThresholdKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NEThresholdKerneloperator= (const NEThresholdKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NEThresholdKernel (NEThresholdKernel &&)=default
 Allow instances of this class to be moved. More...
 
NEThresholdKerneloperator= (NEThresholdKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NEThresholdKernel ()=default
 Default destructor. More...
 
void configure (const ITensor *input, ITensor *output, const ThresholdKernelInfo &info)
 Initialise the kernel's input, output and threshold parameters. 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, const ThresholdKernelInfo &info)
 Static function to check if given info will lead to a valid configuration of NEThresholdKernel. More...
 

Detailed Description

Interface for the thresholding kernel.

Definition at line 36 of file NEThresholdKernel.h.

Constructor & Destructor Documentation

◆ NEThresholdKernel() [1/3]

Default constructor.

Definition at line 72 of file NEThresholdKernel.cpp.

Referenced by NEThresholdKernel::name().

73  : _func(nullptr), _input(nullptr), _output(nullptr), _info()
74 {
75 }

◆ NEThresholdKernel() [2/3]

NEThresholdKernel ( const NEThresholdKernel )
delete

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

◆ NEThresholdKernel() [3/3]

Allow instances of this class to be moved.

◆ ~NEThresholdKernel()

~NEThresholdKernel ( )
default

Default destructor.

Referenced by NEThresholdKernel::name().

Member Function Documentation

◆ configure()

void configure ( const ITensor input,
ITensor output,
const ThresholdKernelInfo info 
)

Initialise the kernel's input, output and threshold parameters.

Parameters
[in]inputAn input tensor. Data type supported: U8
[out]outputThe output tensor. Data type supported: U8.
[in]infoThreshold kernel descriptor

Definition at line 77 of file NEThresholdKernel.cpp.

References ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::BINARY, ITensor::info(), arm_compute::test::validation::info, arm_compute::test::validation::input, arm_compute::RANGE, ThresholdKernelInfo::type, and NEThresholdKernel::validate().

Referenced by NEThresholdKernel::name().

78 {
80  ARM_COMPUTE_ERROR_THROW_ON(validate(input->info(), output->info(), info));
81 
82  _input = input;
83  _output = output;
84  _info = info;
85 
86  switch(_info.type)
87  {
89  _func = &NEThresholdKernel::run_binary;
90  break;
92  _func = &NEThresholdKernel::run_range;
93  break;
94  default:
95  ARM_COMPUTE_ERROR("Thresholding type not recognized");
96  break;
97  }
98 
99  // Configure kernel window
100  auto win_config = validate_and_configure_window(input->info(), output->info());
101  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
102  ICPPKernel::configure(win_config.second);
103 }
#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
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ThresholdKernelInfo &info)
Static function to check if given info will lead to a valid configuration of NEThresholdKernel.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Threshold with two values.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
Threshold with one value.

◆ name()

◆ operator=() [1/2]

NEThresholdKernel& operator= ( const NEThresholdKernel )
delete

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

Referenced by NEThresholdKernel::name().

◆ operator=() [2/2]

NEThresholdKernel& operator= ( NEThresholdKernel &&  )
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 208 of file NEThresholdKernel.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 NEThresholdKernel::name().

209 {
213  ARM_COMPUTE_ERROR_ON(_func == nullptr);
214 
215  (this->*_func)(window);
216 }
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
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205

◆ validate()

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

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

Parameters
[in]inputInput tensor info. Data type supported: U8
[in]outputOutput tensor info. Data type supported: U8
[in]infoThreshold kernel descriptor
Returns
A status containing an error code in case of failure

Definition at line 105 of file NEThresholdKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), Window::collapse_if_possible(), Window::DimX, Window::DimZ, Window::Dimension::end(), arm_compute::execute_window_loop(), ThresholdKernelInfo::false_value, arm_compute::test::validation::input, Iterator::ptr(), Window::set(), Window::Dimension::start(), arm_compute::test::validation::reference::threshold(), ThresholdKernelInfo::threshold, ThresholdKernelInfo::true_value, ThresholdKernelInfo::upper, arm_compute::validate_arguments(), arm_compute::wrapper::vand(), arm_compute::wrapper::vbsl(), arm_compute::wrapper::vcge(), arm_compute::wrapper::vcgt(), arm_compute::wrapper::vcle(), arm_compute::wrapper::vdup_n(), arm_compute::wrapper::vloadq(), arm_compute::wrapper::vstore(), IKernel::window(), and Window::x().

Referenced by NEThresholdKernel::configure(), NEThresholdKernel::name(), and NEThreshold::validate().

106 {
108  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get()).first);
109 
110  return Status{};
111 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
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: