Compute Library
 21.08
CpuComplexMulKernel Class Reference

Interface for the complex pixelwise multiplication kernel. More...

#include <CpuMulKernel.h>

Collaboration diagram for CpuComplexMulKernel:
[legend]

Public Member Functions

 CpuComplexMulKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (CpuComplexMulKernel)
 
void configure (ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst)
 Initialise the kernel's src, 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...
 
- 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 *src1, const ITensorInfo *src2, const ITensorInfo *dst)
 Static function to check if given info will lead to a valid configuration. More...
 

Detailed Description

Interface for the complex pixelwise multiplication kernel.

Definition at line 121 of file CpuMulKernel.h.

Constructor & Destructor Documentation

◆ CpuComplexMulKernel()

CpuComplexMulKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( CpuComplexMulKernel  )

◆ configure()

void configure ( ITensorInfo src1,
ITensorInfo src2,
ITensorInfo dst 
)

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

Parameters
[in]src1An src tensor. Data types supported: F32. Number of channels supported: 2 (complex tensor).
[in]src2An src tensor. Data types supported: same as src1. Number of channels supported: same as src1.
[out]dstThe dst tensor, Data types supported: same as src1. Number of channels supported: same as src1.

Definition at line 1685 of file CpuMulKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), TensorShape::broadcast_shape(), arm_compute::calculate_max_window(), ITensorInfo::data_type(), ITensorInfo::num_channels(), and ITensorInfo::tensor_shape().

1686 {
1687  ARM_COMPUTE_ERROR_ON_NULLPTR(src1, src2, dst);
1688  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments_complex(src1, src2, dst));
1689 
1690  const TensorShape &out_shape = TensorShape::broadcast_shape(src1->tensor_shape(), src2->tensor_shape());
1691 
1692  // Auto initialize dst if not initialized
1693  const TensorInfo out_info(out_shape, src1->num_channels(), src1->data_type());
1694  auto_init_if_empty(*dst, out_info);
1695 
1696  // Configure kernel window
1697  Window win = calculate_max_window(out_shape);
1698 
1699  ICpuKernel::configure(win);
1700 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
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
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

◆ name()

const char * name ( ) const
overridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 1723 of file CpuMulKernel.cpp.

1724 {
1725  return "CpuComplexMulKernel";
1726 }

◆ 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 1710 of file CpuMulKernel.cpp.

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

1711 {
1715 
1716  auto src1 = tensors.get_const_tensor(TensorType::ACL_SRC_0);
1717  auto src2 = tensors.get_const_tensor(TensorType::ACL_SRC_1);
1718  auto dst = tensors.get_tensor(TensorType::ACL_DST);
1719 
1720  c_mul_F32_F32_F32_n(src1, src2, dst, window);
1721 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#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 src1,
const ITensorInfo src2,
const ITensorInfo dst 
)
static

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

Similar to CpuComplexMulKernel::configure()

Returns
a status

Definition at line 1702 of file CpuMulKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, and ARM_COMPUTE_RETURN_ON_ERROR.

Referenced by CpuComplexMul::validate().

1703 {
1704  ARM_COMPUTE_ERROR_ON_NULLPTR(src1, src2, dst);
1705  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments_complex(src1, src2, dst));
1706 
1707  return Status{};
1708 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157

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