Compute Library
 23.11
Data Structures | Public Member Functions | Static Public Member Functions
CpuPool3dKernel Class Reference

Interface for the kernel to perform Pooling 3D. More...

#include <CpuPool3dKernel.h>

Collaboration diagram for CpuPool3dKernel:
[legend]

Data Structures

struct  Pooling3dKernel
 

Public Member Functions

 CpuPool3dKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuPool3dKernel)
 
void configure (const ITensorInfo *src, ITensorInfo *dst, const Pooling3dLayerInfo &pool_info)
 Set the src, dst tensor and pooling info. 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 Window & window () 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, const Pooling3dLayerInfo &pool_info)
 Static function to check if given info will lead to a valid configuration. More...
 
static const std::vector< Pooling3dKernel > & get_available_kernels ()
 
- Static Public Member Functions inherited from ICpuKernel< CpuPool3dKernel >
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

Interface for the kernel to perform Pooling 3D.

Definition at line 39 of file CpuPool3dKernel.h.

Constructor & Destructor Documentation

◆ CpuPool3dKernel()

CpuPool3dKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuPool3dKernel  )

◆ configure()

void configure ( const ITensorInfo *  src,
ITensorInfo *  dst,
const Pooling3dLayerInfo &  pool_info 
)

Set the src, dst tensor and pooling info.

Valid data type configurations:

src dst
F16 F16
F32 F32
QASYMM8 QASYMM8
QASYMM8_SIGNED QASYMM8_SIGNED
Parameters
[in]srcSource tensor info. Data types supported: F16/F32/QASYMM8/QASYMM8_SIGNED.
[out]dstDestination tensor info. Data types supported: Same as src.
[in]pool_infoContains pooling operation information described in Pooling3dLayerInfo.

Definition at line 116 of file CpuPool3dKernel.cpp.

117 {
118  ARM_COMPUTE_ERROR_ON_NULLPTR(src, dst);
119 
120  // Perform validation step
121  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(src, dst, pool_info));
122 
123  // dst auto inizialitation if not yet initialized
124  auto_init_if_empty(*dst, src->clone()->set_tensor_shape(compute_pool3d_shape(src->tensor_shape(), pool_info)));
125 
126  // Get data layout
127  const auto data_layout = src->data_layout();
128  const int idx_width = get_data_layout_dimension_index(data_layout, DataLayoutDimension::WIDTH);
129  const int idx_height = get_data_layout_dimension_index(data_layout, DataLayoutDimension::HEIGHT);
130  const int idx_depth = get_data_layout_dimension_index(data_layout, DataLayoutDimension::DEPTH);
131 
132  // Update pool size in case of global pooling
133  const bool is_global_pooling = pool_info.is_global_pooling;
134  const Size3D pool_size(is_global_pooling ? src->dimension(idx_width) : pool_info.pool_size.width,
135  is_global_pooling ? src->dimension(idx_height) : pool_info.pool_size.height,
136  is_global_pooling ? src->dimension(idx_depth) : pool_info.pool_size.depth);
137 
138  const auto *uk =
139  CpuPool3dKernel::get_implementation(DataTypeISASelectorData{src->data_type(), CPUInfo::get().get_isa()});
140  ARM_COMPUTE_ERROR_ON(uk == nullptr);
141 
142  // Set instance variables
143  _pool_info = pool_info;
144  _run_method = uk->ukernel;
145  _name = std::string("CpuPool3dKernel").append("/").append(uk->name);
146 
147  // Configure kernel window
148  Window win = calculate_max_window(*dst, Steps());
149  ICpuKernel::configure(win);
150 }

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(), arm_compute::misc::shape_calculator::compute_pool3d_shape(), arm_compute::cpu::data_layout, Size3D::depth, arm_compute::DEPTH, arm_compute::test::validation::dst, CPUInfo::get(), arm_compute::get_data_layout_dimension_index(), ICpuKernel< CpuPool3dKernel >::get_implementation(), Size3D::height, arm_compute::HEIGHT, arm_compute::test::validation::idx_height, arm_compute::test::validation::idx_width, Pooling3dLayerInfo::is_global_pooling, Pooling3dLayerInfo::pool_size, arm_compute::test::validation::src, arm_compute::cpu::kernels::validate_arguments(), Size3D::width, and arm_compute::WIDTH.

◆ get_available_kernels()

const std::vector< CpuPool3dKernel::Pooling3dKernel > & get_available_kernels ( )
static

Definition at line 179 of file CpuPool3dKernel.cpp.

180 {
181  return available_kernels;
182 }

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 174 of file CpuPool3dKernel.cpp.

175 {
176  return _name.c_str();
177 }

◆ 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 161 of file CpuPool3dKernel.cpp.

162 {
163  ARM_COMPUTE_UNUSED(info);
164  ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
165  ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICpuKernel::window(), window);
166  ARM_COMPUTE_ERROR_ON(_run_method == nullptr);
167 
168  const ITensor *src = tensors.get_const_tensor(TensorType::ACL_SRC_0);
169  ITensor *dst = tensors.get_tensor(TensorType::ACL_DST_0);
170 
171  _run_method(src, dst, _pool_info, window);
172 }

References arm_compute::ACL_DST_0, arm_compute::ACL_SRC_0, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, arm_compute::test::validation::dst, ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), arm_compute::test::validation::info, arm_compute::test::validation::src, and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo *  src,
const ITensorInfo *  dst,
const Pooling3dLayerInfo &  pool_info 
)
static

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

Similar to CpuPool3dKernel::configure()

Returns
a status

Definition at line 152 of file CpuPool3dKernel.cpp.

153 {
154  ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(src);
155 
156  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(src, dst, pool_info));
157 
158  return Status{};
159 }

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, arm_compute::test::validation::dst, arm_compute::test::validation::src, and arm_compute::cpu::kernels::validate_arguments().

Referenced by CpuPool3d::validate().

The documentation for this class was generated from the following files:
arm_compute::misc::shape_calculator::compute_pool3d_shape
TensorShape compute_pool3d_shape(const TensorShape &src, Pooling3dLayerInfo pool3d_info)
Calculate the output pool3d shape of a tensor.
Definition: ShapeCalculator.h:1655
arm_compute::test::validation::src
SimpleTensor< float > src
Definition: DFT.cpp:155
arm_compute::test::validation::idx_height
const int idx_height
Definition: Scale.cpp:263
arm_compute::calculate_max_window
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
Definition: WindowHelpers.cpp:29
arm_compute::test::validation::dst
auto dst
Definition: DFT.cpp:170
arm_compute::cpu::kernels::validate_arguments
Status validate_arguments(const ITensorInfo *src, const ITensorInfo *weights, const ITensorInfo *dst, const PadStrideInfo &conv_info)
Definition: CpuDirectConv2dKernel.cpp:57
ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:1079
arm_compute::CPUInfo::get
static CPUInfo & get()
Access the KernelLibrary singleton.
Definition: CPPTypes.cpp:41
arm_compute::test::validation::idx_width
const int idx_width
Definition: Scale.cpp:262
arm_compute::ACL_SRC_0
@ ACL_SRC_0
Definition: Types.h:45
arm_compute::DataLayoutDimension::WIDTH
@ WIDTH
width
arm_compute::cpu::data_layout
constexpr auto data_layout
Definition: impl.h:36
ARM_COMPUTE_RETURN_ON_ERROR
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:205
arm_compute::DataLayoutDimension::DEPTH
@ DEPTH
depth
ARM_COMPUTE_ERROR_ON_NULLPTR
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
ARM_COMPUTE_ERROR_ON
#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
ARM_COMPUTE_ERROR_THROW_ON
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
arm_compute::ACL_DST_0
@ ACL_DST_0
Definition: Types.h:56
arm_compute::DataLayoutDimension::HEIGHT
@ HEIGHT
height
arm_compute::auto_init_if_empty
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...
Definition: AutoConfiguration.h:43
ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:203
ARM_COMPUTE_UNUSED
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:151
arm_compute::cpu::ICpuKernel< CpuPool3dKernel >::get_implementation
static const auto * get_implementation(const SelectorType &selector, KernelSelectionType selection_type=KernelSelectionType::Supported)
Micro-kernel selector.
Definition: ICpuKernel.h:54
arm_compute::IKernel::window
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
arm_compute::get_data_layout_dimension_index
size_t get_data_layout_dimension_index(const DataLayout &data_layout, const DataLayoutDimension &data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:201
ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
arm_compute::test::validation::info
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)