Compute Library
 21.02
CLRsqrtLayer Class Reference

Basic function to perform inverse square root on an input tensor. More...

#include <CLElementWiseUnaryLayer.h>

Collaboration diagram for CLRsqrtLayer:
[legend]

Public Member Functions

 CLRsqrtLayer ()
 Default Constructor. More...
 
 ~CLRsqrtLayer ()
 Default Destructor. More...
 
 CLRsqrtLayer (const CLRsqrtLayer &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLRsqrtLayer (CLRsqrtLayer &&)
 Default move constructor. More...
 
CLRsqrtLayeroperator= (const CLRsqrtLayer &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLRsqrtLayeroperator= (CLRsqrtLayer &&)
 Default move assignment operator. More...
 
void configure (const ICLTensor *input, ICLTensor *output)
 Initialize the function. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output)
 Initialize the function. 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 *input, const ITensorInfo *output)
 Static function to check if given info will lead to a valid configuration of CLRsqrtLayer. More...
 

Detailed Description

Basic function to perform inverse square root on an input tensor.

Definition at line 40 of file CLElementWiseUnaryLayer.h.

Constructor & Destructor Documentation

◆ CLRsqrtLayer() [1/3]

Default Constructor.

Definition at line 40 of file CLElementWiseUnaryLayer.cpp.

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

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

◆ ~CLRsqrtLayer()

~CLRsqrtLayer ( )
default

Default Destructor.

Referenced by CLRsqrtLayer::CLRsqrtLayer().

◆ CLRsqrtLayer() [2/3]

CLRsqrtLayer ( const CLRsqrtLayer )
delete

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

◆ CLRsqrtLayer() [3/3]

CLRsqrtLayer ( CLRsqrtLayer &&  )
default

Default move constructor.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output 
)

Initialize the function.

Parameters
[in]inputInput tensor. Data types supported: F16/F32.
[out]outputOutput tensor. Data types supported: same as input.

Definition at line 49 of file CLElementWiseUnaryLayer.cpp.

References CLKernelLibrary::get().

50 {
51  configure(CLKernelLibrary::get().get_compile_context(), input, output);
52 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output)
Initialize the function.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output 
)

Initialize the function.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputInput tensor. Data types supported: F16/F32.
[out]outputOutput tensor. Data types supported: same as input.

Definition at line 54 of file CLElementWiseUnaryLayer.cpp.

References ITensor::info(), and arm_compute::test::validation::input.

55 {
56  _impl->src = input;
57  _impl->dst = output;
58  _impl->op = std::make_unique<opencl::ClRsqrt>();
59  _impl->op->configure(compile_context, input->info(), output->info());
60 }

◆ operator=() [1/2]

CLRsqrtLayer& operator= ( const CLRsqrtLayer )
delete

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

Referenced by CLRsqrtLayer::CLRsqrtLayer().

◆ operator=() [2/2]

CLRsqrtLayer & operator= ( CLRsqrtLayer &&  )
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 67 of file CLElementWiseUnaryLayer.cpp.

References arm_compute::ACL_DST, arm_compute::ACL_SRC, ITensorPack::add_tensor(), arm_compute::test::validation::dst, and arm_compute::test::validation::src.

68 {
69  ITensorPack pack;
70  pack.add_tensor(TensorType::ACL_SRC, _impl->src);
71  pack.add_tensor(TensorType::ACL_DST, _impl->dst);
72  _impl->op->run(pack);
73 }

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output 
)
static

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

Parameters
[in]inputFirst tensor input info. Data types supported: F16/F32.
[in]outputOutput tensor info. Data types supported: Same as input.
Returns
a status

Definition at line 62 of file CLElementWiseUnaryLayer.cpp.

References ClRsqrt::validate().

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

63 {
64  return opencl::ClRsqrt::validate(input, output);
65 }
static Status validate(const ITensorInfo *src, const ITensorInfo *dst)
Static function to check if given info will lead to a valid configuration of ClRsqrt.

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