Compute Library
 21.02
NEComplexPixelWiseMultiplicationKernel Class Reference

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

#include <NEPixelWiseMultiplicationKernel.h>

Collaboration diagram for NEComplexPixelWiseMultiplicationKernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
void configure (ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output)
 Initialise the kernel's input, output and border mode. More...
 
void run_op (ITensorPack &tensors, 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 (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...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output)
 Static function to check if given info will lead to a valid configuration of NEComplexPixelWiseMultiplicationKernel. More...
 

Detailed Description

Interface for the complex pixelwise multiplication kernel.

Definition at line 157 of file NEPixelWiseMultiplicationKernel.h.

Member Function Documentation

◆ configure()

void configure ( ITensorInfo input1,
ITensorInfo input2,
ITensorInfo output 
)

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

Parameters
[in]input1An input tensor. Data types supported: F32. Number of channels supported: 2 (complex tensor).
[in]input2An input tensor. Data types supported: same as input1. Number of channels supported: same as input1.
[out]outputThe output tensor, Data types supported: same as input1. Number of channels supported: same as input1.

Definition at line 1690 of file NEPixelWiseMultiplicationKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), ITensorInfo::broadcast_shape_and_valid_region(), arm_compute::calculate_max_window(), ITensorInfo::data_type(), ITensorInfo::num_channels(), ITensorInfo::num_dimensions(), Dimensions< T >::set_num_dimensions(), ITensorInfo::set_valid_region(), and arm_compute::test::validation::valid_region.

1691 {
1692  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
1693  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments_complex(input1, input2, output));
1694 
1695  const std::pair<TensorShape, ValidRegion> broadcast_pair = ITensorInfo::broadcast_shape_and_valid_region(*input1, *input2);
1696  const TensorShape &out_shape = broadcast_pair.first;
1697  const ValidRegion &valid_region = broadcast_pair.second;
1698 
1699  // Auto initialize output if not initialized
1700  const TensorInfo out_info(out_shape, input1->num_channels(), input1->data_type());
1701  auto_init_if_empty(*output, out_info);
1702 
1703  // Configure kernel window
1704  Coordinates coord;
1705  coord.set_num_dimensions(output->num_dimensions());
1706  output->set_valid_region(valid_region);
1707  Window win = calculate_max_window(valid_region, Steps());
1708 
1709  INEKernel::configure(win);
1710 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
const ValidRegion valid_region
Definition: Scale.cpp:221
static std::pair< TensorShape, ValidRegion > broadcast_shape_and_valid_region(const Infos &... infos)
If infos are broadcast compatible tensor info&#39;s, return the broadcasted shape and the intersection of...
Definition: ITensorInfo.h:271
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:161

◆ name()

const char* name ( ) const
inlineoverridevirtual

Name of the kernel.

Returns
Kernel name

Implements ICPPKernel.

Definition at line 160 of file NEPixelWiseMultiplicationKernel.h.

References NEPixelWiseMultiplicationKernel::configure(), arm_compute::test::validation::info, NEPixelWiseMultiplicationKernel::run_op(), NEPixelWiseMultiplicationKernel::validate(), and IKernel::window().

161  {
162  return "NEComplexPixelWiseMultiplicationKernel";
163  }

◆ 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 1720 of file NEPixelWiseMultiplicationKernel.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().

1721 {
1725 
1726  auto input1 = tensors.get_const_tensor(TensorType::ACL_SRC_0);
1727  auto input2 = tensors.get_const_tensor(TensorType::ACL_SRC_1);
1728  auto output = tensors.get_tensor(TensorType::ACL_DST);
1729 
1730  c_mul_F32_F32_F32_n(input1, input2, output, window);
1731 }
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: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 input1,
const ITensorInfo input2,
const ITensorInfo output 
)
static

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

Parameters
[in]input1An input tensor info. Data types supported: F32. Number of channels supported: 2 (complex tensor).
[in]input2An input tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
[in]outputThe output tensor info. Data types supported: same as input1. Number of channels supported: same as input1.
Returns
a status

Definition at line 1712 of file NEPixelWiseMultiplicationKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, and ARM_COMPUTE_RETURN_ON_ERROR.

Referenced by NEComplexPixelWiseMultiplication::validate().

1713 {
1714  ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output);
1715  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments_complex(input1, input2, output));
1716 
1717  return Status{};
1718 }
#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:161

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