Compute Library
 21.02
CLElementwisePower Class Reference

Basic function to run opencl::kernels::ClArithmeticKernel for power. More...

#include <CLElementwiseOperations.h>

Collaboration diagram for CLElementwisePower:
[legend]

Public Member Functions

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

Detailed Description

Basic function to run opencl::kernels::ClArithmeticKernel for power.

Note
The tensor data type for the inputs must be F16/F32.
The function performs an elementwise power of in1 to in2 (i.e., out[i] = in1[i] ^ in2[i])

Definition at line 493 of file CLElementwiseOperations.h.

Constructor & Destructor Documentation

◆ CLElementwisePower() [1/3]

Default Constructor.

Definition at line 317 of file CLElementwiseOperations.cpp.

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

318  : _impl(std::make_unique<Impl>())
319 {
320 }

◆ ~CLElementwisePower()

~CLElementwisePower ( )
default

Default Destructor.

Referenced by CLElementwisePower::CLElementwisePower().

◆ CLElementwisePower() [2/3]

CLElementwisePower ( const CLElementwisePower )
delete

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

◆ CLElementwisePower() [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 and conversion policy.

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. 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.
[out]outputOutput tensor. Data types supported:F16/F32.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 325 of file CLElementwiseOperations.cpp.

References CLKernelLibrary::get().

326 {
327  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, act_info);
328 }
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 and conversion policy.

◆ configure() [2/2]

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

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

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. 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.
[out]outputOutput tensor. Data types supported:F16/F32.
[in]act_info(Optional) Activation layer information in case of a fused activation.

Definition at line 330 of file CLElementwiseOperations.cpp.

References ITensor::info().

331 {
332  _impl->src_0 = input1;
333  _impl->src_1 = input2;
334  _impl->dst = output;
335  _impl->op = std::make_unique<opencl::ClElementwisePower>();
336  _impl->op->configure(compile_context, input1->info(), input2->info(), output->info(), act_info);
337 }

◆ operator=() [1/2]

CLElementwisePower& operator= ( const CLElementwisePower )
delete

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

Referenced by CLElementwisePower::CLElementwisePower().

◆ operator=() [2/2]

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

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

345 {
346  ITensorPack pack;
347  pack.add_tensor(TensorType::ACL_SRC_0, _impl->src_0);
348  pack.add_tensor(TensorType::ACL_SRC_1, _impl->src_1);
349  pack.add_tensor(TensorType::ACL_DST, _impl->dst);
350 
351  _impl->op->run(pack);
352 }

◆ 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 opencl::kernels::ClArithmeticKernel for power.

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

Definition at line 339 of file CLElementwiseOperations.cpp.

References ClElementwisePower::validate().

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

340 {
341  return opencl::ClElementwisePower::validate(input1, input2, output, act_info);
342 }
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 opencl::kernels::ClArith...

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