Compute Library
 21.02
CLArithmeticDivision Class Reference

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

#include <CLElementwiseOperations.h>

Collaboration diagram for CLArithmeticDivision:
[legend]

Public Member Functions

 CLArithmeticDivision ()
 Default Constructor. More...
 
 ~CLArithmeticDivision ()
 Default Destructor. More...
 
 CLArithmeticDivision (const CLArithmeticDivision &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLArithmeticDivision (CLArithmeticDivision &&)
 Default move constructor. More...
 
CLArithmeticDivisionoperator= (const CLArithmeticDivision &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLArithmeticDivisionoperator= (CLArithmeticDivision &&)
 Default move assignment operator. More...
 
void configure (ICLTensor *input1, ICLTensor *input2, ICLTensor *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's inputs, output. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Initialise the kernel's inputs, output. 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, const ActivationLayerInfo &act_info=ActivationLayerInfo())
 Static function to check if given info will lead to a valid configuration of CLArithmeticDivision. More...
 

Detailed Description

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

Note
The tensor data type for the inputs must be F16/F32.
The function performs an arithmetic division between two tensors.

Definition at line 253 of file CLElementwiseOperations.h.

Constructor & Destructor Documentation

◆ CLArithmeticDivision() [1/3]

Default Constructor.

Definition at line 137 of file CLElementwiseOperations.cpp.

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

138  : _impl(std::make_unique<Impl>())
139 {
140 }

◆ ~CLArithmeticDivision()

~CLArithmeticDivision ( )
default

Default Destructor.

Referenced by CLArithmeticDivision::CLArithmeticDivision().

◆ CLArithmeticDivision() [2/3]

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

◆ CLArithmeticDivision() [3/3]

Default move constructor.

Member Function Documentation

◆ configure() [1/2]

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

Initialise the kernel's inputs, output.

Parameters
[in,out]input1First tensor input. Data types supported: 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. Same as input1. 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: Same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 145 of file CLElementwiseOperations.cpp.

References CLKernelLibrary::get().

146 {
147  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, act_info);
148 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Initialise the kernel&#39;s inputs, output.

◆ configure() [2/2]

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

Initialise the kernel's inputs, output.

Parameters
[in]compile_contextThe compile context to be used.
[in,out]input1First tensor input. Data types supported: 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. Same as input1. 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: Same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 150 of file CLElementwiseOperations.cpp.

References ITensor::info().

151 {
152  _impl->src_0 = input1;
153  _impl->src_1 = input2;
154  _impl->dst = output;
155  _impl->op = std::make_unique<opencl::ClElementwiseDivision>();
156  _impl->op->configure(compile_context, input1->info(), input2->info(), output->info(), act_info);
157 }

◆ operator=() [1/2]

CLArithmeticDivision& operator= ( const CLArithmeticDivision )
delete

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

Referenced by CLArithmeticDivision::CLArithmeticDivision().

◆ operator=() [2/2]

CLArithmeticDivision & operator= ( CLArithmeticDivision &&  )
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 164 of file CLElementwiseOperations.cpp.

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

165 {
166  ITensorPack pack;
167  pack.add_tensor(TensorType::ACL_SRC_0, _impl->src_0);
168  pack.add_tensor(TensorType::ACL_SRC_1, _impl->src_1);
169  pack.add_tensor(TensorType::ACL_DST, _impl->dst);
170 
171  _impl->op->run(pack);
172 }

◆ validate()

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

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

Parameters
[in]input1First tensor input info. Data types supported: F16/F32.
[in]input2Second tensor input info. Data types supported: Same as input1.
[in]outputOutput tensor info. Data types supported: Same as input1.
[in]act_info(Optional) Activation layer information in case of a fused activation.
Returns
a status

Definition at line 159 of file CLElementwiseOperations.cpp.

References ClElementwiseDivision::validate().

Referenced by arm_compute::test::validation::DATA_TEST_CASE().

160 {
161  return opencl::ClElementwiseDivision::validate(input1, input2, output, act_info);
162 }
static Status validate(const ITensorInfo *src1, const ITensorInfo *src2, const ITensorInfo *dst, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Static function to check if given info will lead to a valid configuration of ClElementwiseDivision.

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