Compute Library
 21.02
NEArithmeticSubtraction Class Reference

Basic function to run cpu::kernels::CpuSubKernel. More...

#include <NEArithmeticSubtraction.h>

Collaboration diagram for NEArithmeticSubtraction:
[legend]

Public Member Functions

 NEArithmeticSubtraction ()
 Default Constructor. More...
 
 ~NEArithmeticSubtraction ()
 Default Destructor. More...
 
 NEArithmeticSubtraction (const NEArithmeticSubtraction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NEArithmeticSubtraction (NEArithmeticSubtraction &&)
 Default move constructor. More...
 
NEArithmeticSubtractionoperator= (const NEArithmeticSubtraction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NEArithmeticSubtractionoperator= (NEArithmeticSubtraction &&)
 Default move assignment operator. More...
 
void configure (const ITensor *input1, const ITensor *input2, ITensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's inputs, output and conversion policy. More...
 
void run () override
 Run the kernels contained in the function. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Static function to check if given info will lead to a valid configuration of NEArithmeticSubtraction. More...
 

Detailed Description

Basic function to run cpu::kernels::CpuSubKernel.

Note
The tensor data type for the inputs must be U8/QASYMM8/S16/S32/F16/F32.
The function performs an arithmetic subtraction between two tensors.

This function calls the following kernels:

  1. cpu::kernels::CpuSubKernel

Definition at line 43 of file NEArithmeticSubtraction.h.

Constructor & Destructor Documentation

◆ NEArithmeticSubtraction() [1/3]

Default Constructor.

Definition at line 41 of file NEArithmeticSubtraction.cpp.

References NEArithmeticSubtraction::operator=(), and NEArithmeticSubtraction::~NEArithmeticSubtraction().

42  : _impl(std::make_unique<Impl>())
43 {
44 }

◆ ~NEArithmeticSubtraction()

Default Destructor.

Referenced by NEArithmeticSubtraction::NEArithmeticSubtraction().

◆ NEArithmeticSubtraction() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ NEArithmeticSubtraction() [3/3]

Default move constructor.

Member Function Documentation

◆ configure()

void configure ( const ITensor input1,
const ITensor input2,
ITensor output,
ConvertPolicy  policy,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)

Initialise the kernel's inputs, output and conversion policy.

Parameters
[in]input1First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
[in]input2Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
[out]outputOutput tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
[in]policyPolicy to use to handle overflow. Convert policy cannot be WRAP if datatype is quantized.
[in]act_info(Optional) Activation layer information in case of a fused activation. Currently not supported.

Definition at line 54 of file NEArithmeticSubtraction.cpp.

References ITensor::info().

Referenced by NELSTMLayer::configure(), and NEQLSTMLayer::configure().

55 {
56  _impl->src_0 = input1;
57  _impl->src_1 = input2;
58  _impl->dst = output;
59  _impl->op = std::make_unique<cpu::CpuSub>();
60  _impl->op->configure(input1->info(), input2->info(), output->info(), policy, act_info);
61 }

◆ operator=() [1/2]

NEArithmeticSubtraction& operator= ( const NEArithmeticSubtraction )
delete

Prevent instances of this class from being copied (As this class contains pointers)

Referenced by NEArithmeticSubtraction::NEArithmeticSubtraction().

◆ operator=() [2/2]

NEArithmeticSubtraction & operator= ( NEArithmeticSubtraction &&  )
default

Default move assignment operator.

◆ run()

void run ( )
overridevirtual

Run the kernels contained in the function.

For Neon kernels:

  • Multi-threading is used for the kernels which are parallelisable.
  • By default std::thread::hardware_concurrency() threads are used.
Note
CPPScheduler::set_num_threads() can be used to manually set the number of threads

For OpenCL kernels:

  • All the kernels are enqueued on the queue associated with CLScheduler.
  • The queue is then flushed.
Note
The function will not block until the kernels are executed. It is the user's responsibility to wait.
Will call prepare() on first run if hasn't been done

Implements IFunction.

Definition at line 63 of file NEArithmeticSubtraction.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, and ITensorPack::add_tensor().

Referenced by NELSTMLayer::run(), and NEQLSTMLayer::run().

64 {
65  ITensorPack pack;
66  pack.add_tensor(TensorType::ACL_SRC_0, _impl->src_0);
67  pack.add_tensor(TensorType::ACL_SRC_1, _impl->src_1);
68  pack.add_tensor(TensorType::ACL_DST, _impl->dst);
69  _impl->op->run(pack);
70 }

◆ validate()

Status validate ( const ITensorInfo input1,
const ITensorInfo input2,
const ITensorInfo output,
ConvertPolicy  policy,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)
static

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

Parameters
[in]input1First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
[in]input2Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
[in]outputOutput tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
[in]policyPolicy to use to handle overflow. Convert policy cannot be WRAP if datatype is quantized.
[in]act_info(Optional) Activation layer information in case of a fused activation. Currently not supported.
Returns
a status

Definition at line 49 of file NEArithmeticSubtraction.cpp.

References CpuSub::validate().

Referenced by arm_compute::test::validation::DATA_TEST_CASE(), NELSTMLayer::validate(), and NEQLSTMLayer::validate().

50 {
51  return cpu::CpuSub::validate(input1, input2, output, policy, act_info);
52 }
static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Static function to check if given info will lead to a valid configuration of CpuSub.
Definition: CpuSub.cpp:40

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