Compute Library
 22.11
CpuFloorKernel Class Reference

Cpu accelarated kernel to perform a floor operation. More...

#include <CpuFloorKernel.h>

Collaboration diagram for CpuFloorKernel:
[legend]

Data Structures

struct  FloorKernel
 

Public Member Functions

 CpuFloorKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuFloorKernel)
 
void configure (const ITensorInfo *src, ITensorInfo *dst)
 Configure kernel for a given list of arguments. More...
 
Window infer_window (const ITensorInfo *src, const ITensorInfo *dst)
 Infer execution window. More...
 
void run_op (ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
 Execute the kernel on the passed window. More...
 
const char * name () const override
 Name of the kernel. More...
 
- Public Member Functions inherited from ICPPKernel
virtual ~ICPPKernel ()=default
 Default destructor. More...
 
virtual void run (const Window &window, const ThreadInfo &info)
 Execute the kernel on the passed window. 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 size_t get_mws (const CPUInfo &platform, size_t thread_count) const
 Return minimum workload size of the relevant kernel. 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...
 
bool is_window_configured () const
 Function to check if the embedded window of this kernel has been configured. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *src, const ITensorInfo *dst)
 Static function to check if given info will lead to a valid configuration. More...
 
static const std::vector< FloorKernel > & get_available_kernels ()
 
- Static Public Member Functions inherited from ICpuKernel< CpuFloorKernel >
static const auto * get_implementation (const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
 Micro-kernel selector. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ICPPKernel
static constexpr size_t default_mws = 1
 

Detailed Description

Cpu accelarated kernel to perform a floor operation.

Definition at line 37 of file CpuFloorKernel.h.

Constructor & Destructor Documentation

◆ CpuFloorKernel()

CpuFloorKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuFloorKernel  )

◆ configure()

void configure ( const ITensorInfo src,
ITensorInfo dst 
)

Configure kernel for a given list of arguments.

Parameters
[in]srcSource tensor. Data type supported: F16/F32.
[out]dstDestination tensor. Same as src

Definition at line 77 of file CpuFloorKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), ITensorInfo::data_type(), CPUInfo::get(), ICpuKernel< CpuFloorKernel >::get_implementation(), CPUInfo::get_isa(), ITensorInfo::tensor_shape(), and arm_compute::cpu::kernels::validate_arguments().

78 {
81 
82  auto_init_if_empty(*dst, src->tensor_shape(), 1, src->data_type());
83 
84  const auto *uk = CpuFloorKernel::get_implementation(DataTypeISASelectorData{ src->data_type(), CPUInfo::get().get_isa() });
86 
87  _run_method = uk->ukernel;
88  _name = std::string("CpuFloorKernel").append("/").append(uk->name);
89 
90  // Configure kernel window
91  const Window win = calculate_max_window(*src, Steps());
92 
93  ICPPKernel::configure(win);
94 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
static const auto * get_implementation(const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
Micro-kernel selector.
Definition: ICpuKernel.h:53
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
SimpleTensor< float > src
Definition: DFT.cpp:155
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...
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
static CPUInfo & get()
Access the KernelLibrary singleton.
Definition: CPPTypes.cpp:40
cpuinfo::CpuIsaInfo get_isa() const
Gets the current cpu&#39;s ISA information.
Definition: CPPTypes.cpp:124

◆ get_available_kernels()

const std::vector< CpuFloorKernel::FloorKernel > & get_available_kernels ( )
static

Definition at line 143 of file CpuFloorKernel.cpp.

144 {
145  return available_kernels;
146 }

◆ infer_window()

Window infer_window ( const ITensorInfo src,
const ITensorInfo dst 
)

Infer execution window.

Parameters
[in]srcSource tensor info. Data type supported: F16/F32.
[in]dstDestination tensor info. Same as src
Returns
an execution Window

Definition at line 96 of file CpuFloorKernel.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_UNUSED, ITensorInfo::tensor_shape(), Window::use_tensor_dimensions(), and arm_compute::cpu::kernels::validate_arguments().

97 {
100 
101  Window win;
102  win.use_tensor_dimensions(src->tensor_shape());
103  return win;
104 }
#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
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
SimpleTensor< float > src
Definition: DFT.cpp:155
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 138 of file CpuFloorKernel.cpp.

139 {
140  return _name.c_str();
141 }

◆ run_op()

void run_op ( ITensorPack tensors,
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]tensorsA vector containing the tensors to operate on.
[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 112 of file CpuFloorKernel.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, Window::DimX, ITensorPack::empty(), Window::Dimension::end(), arm_compute::execute_window_loop(), ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), Iterator::ptr(), Window::set(), Window::Dimension::start(), IKernel::window(), and Window::x().

113 {
117 
118  ARM_COMPUTE_ERROR_ON(tensors.empty());
119  ARM_COMPUTE_ERROR_ON(_run_method == nullptr);
120 
121  const ITensor *src = tensors.get_const_tensor(TensorType::ACL_SRC);
122  ITensor *dst = tensors.get_tensor(TensorType::ACL_DST);
123  const auto len = static_cast<int>(window.x().end()) - static_cast<int>(window.x().start());
124 
125  Window win{ window };
126  win.set(Window::DimX, Window::Dimension(0, 1, 1));
127 
128  Iterator src_it(src, win);
129  Iterator dst_it(dst, win);
130 
131  execute_window_loop(win, [&](const Coordinates &)
132  {
133  _run_method(src_it.ptr(), dst_it.ptr(), len);
134  },
135  src_it, dst_it);
136 }
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
SimpleTensor< float > src
Definition: DFT.cpp:155
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
void execute_window_loop(const Window &w, L &&lambda_function, Ts &&... iterators)
Iterate through the passed window, automatically adjusting the iterators and calling the lambda_funct...
Definition: Helpers.inl:77
constexpr int end() const
Return the end of the dimension.
Definition: Window.h:102
constexpr int start() const
Return the start of the dimension.
Definition: Window.h:97
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
constexpr const Dimension & x() const
Alias to access the first dimension of the window.
Definition: Window.h:159

◆ validate()

Status validate ( const ITensorInfo src,
const ITensorInfo dst 
)
static

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

Similar to CpuFloorKernel::configure()

Returns
a status

Definition at line 106 of file CpuFloorKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, and arm_compute::cpu::kernels::validate_arguments().

Referenced by CpuFloor::validate().

107 {
109  return Status{};
110 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)

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