Compute Library
 22.08
CLArithmeticSubtraction Class Reference

Basic function to run opencl::kernels::ClSaturatedArithmeticKernel for subtraction. More...

#include <CLElementwiseOperations.h>

Collaboration diagram for CLArithmeticSubtraction:
[legend]

Public Member Functions

 CLArithmeticSubtraction ()
 Default Constructor. More...
 
 ~CLArithmeticSubtraction ()
 Default Destructor. More...
 
 CLArithmeticSubtraction (const CLArithmeticSubtraction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLArithmeticSubtraction (CLArithmeticSubtraction &&)
 Default move constructor. More...
 
CLArithmeticSubtractionoperator= (const CLArithmeticSubtraction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLArithmeticSubtractionoperator= (CLArithmeticSubtraction &&)
 Default move assignment operator. More...
 
void configure (const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's inputs, output and conversion policy. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *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 opencl::kernels::ClSaturatedArithmeticKernel for subtraction. More...
 

Detailed Description

Basic function to run opencl::kernels::ClSaturatedArithmeticKernel for subtraction.

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

Definition at line 151 of file CLElementwiseOperations.h.

Constructor & Destructor Documentation

◆ CLArithmeticSubtraction() [1/3]

Default Constructor.

Definition at line 91 of file CLElementwiseOperations.cpp.

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

92  : _impl(std::make_unique<Impl>())
93 {
94 }

◆ ~CLArithmeticSubtraction()

Default Destructor.

Referenced by CLArithmeticSubtraction::CLArithmeticSubtraction().

◆ CLArithmeticSubtraction() [2/3]

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

◆ CLArithmeticSubtraction() [3/3]

Default move constructor.

Member Function Documentation

◆ configure() [1/2]

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

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

Valid data layouts:

  • All

Valid data type configurations:

src0 src1 dst
QASYMM8 QASYMM8 QASYMM8
QASYMM8_SIGNED QASYMM8_SIGNED QASYMM8_SIGNED
QSYMM16 QSYMM16 QASYMM16
U8 U8 U8
U8 U8 S16
U8 S16 S16
S16 U8 S16
S16 S16 S16
S32 S32 S32
F16 F16 F16
F32 F32 F32
Parameters
[in,out]input1First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
[in,out]input2Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
[out]outputOutput tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32.
[in]policyPolicy to use to handle overflow.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 99 of file CLElementwiseOperations.cpp.

References CLKernelLibrary::get().

Referenced by CLLSTMLayer::configure(), and CLQLSTMLayer::configure().

100 {
101  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, policy, act_info);
102 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Initialise the kernel&#39;s inputs, output and conversion policy.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input1,
const ICLTensor input2,
ICLTensor output,
ConvertPolicy  policy,
const ActivationLayerInfo act_info = ActivationLayerInfo() 
)

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

Valid configurations (Input1,Input2) -> Output :

  • (U8,U8) -> U8
  • (U8,U8) -> S16
  • (S16,U8) -> S16
  • (U8,S16) -> S16
  • (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]compile_contextThe compile context to be used.
[in,out]input1First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
[in,out]input2Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
[out]outputOutput tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32.
[in]policyPolicy to use to handle overflow.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 104 of file CLElementwiseOperations.cpp.

References ITensor::info().

106 {
107  _impl->src_0 = input1;
108  _impl->src_1 = input2;
109  _impl->dst = output;
110  _impl->op = std::make_unique<opencl::ClSub>();
111  _impl->op->configure(compile_context, input1->info(), input2->info(), output->info(), policy, act_info);
112 }

◆ operator=() [1/2]

CLArithmeticSubtraction& operator= ( const CLArithmeticSubtraction )
delete

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

Referenced by CLArithmeticSubtraction::CLArithmeticSubtraction().

◆ operator=() [2/2]

CLArithmeticSubtraction & operator= ( CLArithmeticSubtraction &&  )
default

Default move assignment operator.

◆ run()

void run ( )
overridevirtual

Run the kernels contained in the function.

For CPU 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 119 of file CLElementwiseOperations.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, ITensorPack::add_tensor(), arm_compute::test::validation::dst, and arm_compute::test::validation::pack.

Referenced by CLLSTMLayer::run(), and CLQLSTMLayer::run().

120 {
121  ITensorPack pack;
122  pack.add_tensor(TensorType::ACL_SRC_0, _impl->src_0);
123  pack.add_tensor(TensorType::ACL_SRC_1, _impl->src_1);
124  pack.add_tensor(TensorType::ACL_DST, _impl->dst);
125 
126  _impl->op->run(pack);
127 }
void add_tensor(int id, ITensor *tensor)
Add tensor to the pack.
Definition: ITensorPack.cpp:39

◆ 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 opencl::kernels::ClSaturatedArithmeticKernel for subtraction.

Valid configurations (Input1,Input2) -> Output :

  • (U8,U8) -> U8
  • (U8,U8) -> S16
  • (S16,U8) -> S16
  • (U8,S16) -> S16
  • (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]input1First tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32.
[in]input2Second tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32.
[in]outputOutput tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32.
[in]policyPolicy to use to handle overflow.
[in]act_info(Optional) Activation layer information in case of a fused activation.
Returns
a status

Definition at line 114 of file CLElementwiseOperations.cpp.

References ClSub::validate().

Referenced by arm_compute::test::validation::TEST_CASE(), CLLSTMLayer::validate(), and CLQLSTMLayer::validate().

115 {
116  return opencl::ClSub::validate(input1, input2, output, policy, act_info);
117 }
static Status validate(const ITensorInfo *src1, const ITensorInfo *src2, const ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Static function to check if given info will lead to a valid configuration.
Definition: ClSub.cpp:44

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