Compute Library
 22.11
CpuAddKernel Class Reference

Interface for the kernel to perform addition between two tensors. More...

#include <CpuAddKernel.h>

Collaboration diagram for CpuAddKernel:
[legend]

Data Structures

struct  AddKernel
 

Public Member Functions

 CpuAddKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuAddKernel)
 
void configure (const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy)
 Initialise the kernel's input, dst and border mode. 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...
 
size_t get_mws (const CPUInfo &platform, size_t thread_count) const override
 Return minimum workload size of the relevant kernel. More...
 
size_t get_split_dimension () const
 
- 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...
 
- 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 *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy)
 Static function to check if given info will lead to a valid configuration. More...
 
static const std::vector< AddKernel > & get_available_kernels ()
 
- Static Public Member Functions inherited from ICpuKernel< CpuAddKernel >
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 addition between two tensors.

Definition at line 37 of file CpuAddKernel.h.

Constructor & Destructor Documentation

◆ CpuAddKernel()

CpuAddKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuAddKernel  )

◆ configure()

void configure ( const ITensorInfo src0,
const ITensorInfo src1,
ITensorInfo dst,
ConvertPolicy  policy 
)

Initialise the kernel's input, dst and border mode.

Valid configurations (src0,src1) -> dst :

  • (U8,U8) -> U8
  • (S16,S16) -> S16
  • (S32,S32) -> S32
  • (F16,F16) -> F16
  • (F32,F32) -> F32
  • (QASYMM8,QASYMM8) -> QASYMM8
  • (QASYMM8_SIGNED,QASYMM8_SIGNED) -> QASYMM8_SIGNED
  • (QSYMM16,QSYMM16) -> QSYMM16
Parameters
[in]src0First input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
[in]src1Second input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
[out]dstThe dst tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32.
[in]policyOverflow policy.

Definition at line 205 of file CpuAddKernel.cpp.

References arm_compute::cpu::add_q8_neon_fixedpoint_possible(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, TensorShape::broadcast_shape(), arm_compute::calculate_squashed_or_max_window(), ITensorInfo::data_type(), CPUInfo::get(), CPUInfo::get_isa(), arm_compute::set_data_type_if_unknown(), arm_compute::set_shape_if_empty(), ITensorInfo::tensor_shape(), and arm_compute::cpu::kernels::validate_arguments().

206 {
207  ARM_COMPUTE_ERROR_ON_NULLPTR(src0, src1, dst);
208  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(*src0, *src1, *dst, policy));
209 
210  const auto can_use_fixedpoint = add_q8_neon_fixedpoint_possible(src0, src1, dst);
211  const auto uk = CpuAddKernel::get_implementation<CpuAddKernelDataTypeISASelectorData>(CpuAddKernelDataTypeISASelectorData{ src0->data_type(),
212  CPUInfo::get().get_isa(), can_use_fixedpoint });
213 
215 
216  _policy = policy;
217  _run_method = uk->ukernel;
218  _name = std::string("CpuAddKernel").append("/").append(uk->name);
219 
220  // Auto initialize dst if not initialized
221  const TensorShape &out_shape = TensorShape::broadcast_shape(src0->tensor_shape(), src1->tensor_shape());
222  set_shape_if_empty(*dst, out_shape);
223  set_data_type_if_unknown(*dst, src0->data_type());
224 
225  // Configure kernel window
226  Window win;
227  std::tie(win, _split_dimension) = calculate_squashed_or_max_window(*src0, *src1);
228 
229  ICpuKernel::configure(win);
230 }
bool set_data_type_if_unknown(ITensorInfo &info, DataType data_type)
Set the data type and number of channels to the specified value if the current data type is unknown...
static TensorShape broadcast_shape(const Shapes &... shapes)
If shapes are broadcast compatible, return the broadcasted shape.
Definition: TensorShape.h:211
#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)
bool set_shape_if_empty(ITensorInfo &info, const TensorShape &shape)
Set the shape to the specified value if the current assignment is empty.
std::pair< Window, size_t > calculate_squashed_or_max_window(const ITensorInfo &src0, const ITensorInfo &src1)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
static CPUInfo & get()
Access the KernelLibrary singleton.
Definition: CPPTypes.cpp:40
bool add_q8_neon_fixedpoint_possible(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst)
Definition: impl.cpp:131
cpuinfo::CpuIsaInfo get_isa() const
Gets the current cpu&#39;s ISA information.
Definition: CPPTypes.cpp:124

◆ get_available_kernels()

const std::vector< CpuAddKernel::AddKernel > & get_available_kernels ( )
static

Definition at line 262 of file CpuAddKernel.cpp.

263 {
264  return available_kernels;
265 }

◆ get_mws()

size_t get_mws ( const CPUInfo platform,
size_t  thread_count 
) const
overridevirtual

Return minimum workload size of the relevant kernel.

Parameters
[in]platformThe CPU platform used to create the context.
[in]thread_countNumber of threads in the execution.
Returns
[out] small_network_mws Minimum workload size for requsted configuration.

Reimplemented from ICPPKernel.

Definition at line 267 of file CpuAddKernel.cpp.

References ARM_COMPUTE_UNUSED, and ICPPKernel::default_mws.

268 {
269  ARM_COMPUTE_UNUSED(thread_count);
270  ARM_COMPUTE_UNUSED(platform);
271 
273 }
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
static constexpr size_t default_mws
Definition: ICPPKernel.h:41

◆ get_split_dimension()

size_t get_split_dimension ( ) const
inline

Definition at line 94 of file CpuAddKernel.h.

References Window::DimY.

95  {
96  return _split_dimension;
97  }

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 257 of file CpuAddKernel.cpp.

258 {
259  return _name.c_str();
260 }

◆ 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 241 of file CpuAddKernel.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, ITensorPack::empty(), ITensorPack::get_const_tensor(), ITensorPack::get_tensor(), and IKernel::window().

242 {
246 
247  ARM_COMPUTE_ERROR_ON(tensors.empty());
248  ARM_COMPUTE_ERROR_ON(_run_method == nullptr);
249 
250  const ITensor *src0 = tensors.get_const_tensor(TensorType::ACL_SRC_0);
251  const ITensor *src1 = tensors.get_const_tensor(TensorType::ACL_SRC_1);
252  ITensor *dst = tensors.get_tensor(TensorType::ACL_DST);
253 
254  _run_method(src0, src1, dst, _policy, window);
255 }
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:915
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201

◆ validate()

Status validate ( const ITensorInfo src0,
const ITensorInfo src1,
const ITensorInfo dst,
ConvertPolicy  policy 
)
static

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

Similar to CpuAddKernel::configure()

Returns
a status

Definition at line 232 of file CpuAddKernel.cpp.

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

Referenced by CpuAdd::validate().

233 {
235 
236  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(*src0, *src1, *dst, policy));
237 
238  return Status{};
239 }
#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)
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159

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